Collaboration diagram for Overlays:

Namespaces
	Ogre::OverlayElementCommands

Classes
class	Ogre::BorderPanelOverlayElement
	A specialisation of the PanelOverlayElement to provide a panel with a border. More...

class	Ogre::BorderPanelOverlayElementFactory
	Factory for creating BorderPanelOverlayElement instances. More...

class	Ogre::BorderRenderable
	Class for rendering the border of a BorderPanelOverlayElement. More...

class	Ogre::Overlay
	Represents a layer which is rendered on top of the 'normal' scene contents. More...

class	Ogre::OverlayContainer
	A 2D element which contains other OverlayElement instances. More...

class	Ogre::OverlayElement
	Abstract definition of a 2D element to be displayed in an Overlay. More...

class	Ogre::OverlayElementFactory
	Defines the interface which all components wishing to supply OverlayElement subclasses must implement. More...

class	Ogre::OverlayManager
	Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

class	Ogre::OverlayProfileSessionListener
	Concrete impl. More...

class	Ogre::OverlaySystem
	This class simplify initialization / finalization of the overlay system. More...

class	Ogre::PanelOverlayElement
	OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...

class	Ogre::PanelOverlayElementFactory
	Factory for creating PanelOverlayElement instances. More...

class	Ogre::TextAreaOverlayElement
	This class implements an overlay element which contains simple unformatted text. More...

class	Ogre::TextAreaOverlayElementFactory
	Factory for creating TextAreaOverlayElement instances. More...

Macros
#define	OGRE_DEREF_DISPLAYSTRING_ITERATOR(it) *it

Typedefs
typedef String	Ogre::DisplayString

typedef list< OverlayElement * > ::type	Ogre::OverlayProfileSessionListener::ProfileBarList

Enumerations
enum	Ogre::GuiHorizontalAlignment { Ogre::GHA_LEFT, Ogre::GHA_CENTER, Ogre::GHA_RIGHT }
	Enum describing where '0' is in relation to the parent in the horizontal dimension. More...

enum	Ogre::GuiMetricsMode { Ogre::GMM_RELATIVE, Ogre::GMM_PIXELS, Ogre::GMM_RELATIVE_ASPECT_ADJUSTED }
	Enum describing how the position / size of an element is to be recorded. More...

enum	Ogre::GuiVerticalAlignment { Ogre::GVA_TOP, Ogre::GVA_CENTER, Ogre::GVA_BOTTOM }
	Enum describing where '0' is in relation to the parent in the vertical dimension. More...

Functions
	Ogre::OverlayProfileSessionListener::OverlayProfileSessionListener ()

	Ogre::OverlaySystem::OverlaySystem ()

virtual	Ogre::OverlayProfileSessionListener::~OverlayProfileSessionListener ()

virtual	Ogre::OverlaySystem::~OverlaySystem ()

virtual void	Ogre::OverlayProfileSessionListener::changeEnableState (bool enabled)

OverlayContainer *	Ogre::OverlayProfileSessionListener::createContainer ()
	An internal function to create the container which will hold our display elements. More...

OverlayElement *	Ogre::OverlayProfileSessionListener::createPanel (const String &name, Real width, Real height, Real top, Real left, const String &materialName, bool show=true)
	An internal function to create a panel. More...

OverlayElement *	Ogre::OverlayProfileSessionListener::createTextArea (const String &name, Real width, Real height, Real top, Real left, uint fontSize, const String &caption, bool show=true)
	An internal function to create a text area. More...

virtual void	Ogre::OverlayProfileSessionListener::displayResults (const ProfileInstance &instance, ulong maxTotalFrameTime)

void	Ogre::OverlayProfileSessionListener::displayResults (ProfileInstance *instance, ProfileBarList::const_iterator &bIter, Real &maxTimeMillisecs, Real &newGuiHeight, int &profileCount)
	Prints the profiling results of each frame. More...

virtual void	Ogre::OverlayProfileSessionListener::finializeSession ()

Real	Ogre::OverlayProfileSessionListener::getOverlayHeight () const

Real	Ogre::OverlayProfileSessionListener::getOverlayLeft () const

Real	Ogre::OverlayProfileSessionListener::getOverlayTop () const

Real	Ogre::OverlayProfileSessionListener::getOverlayWidth () const

virtual void	Ogre::OverlayProfileSessionListener::initializeSession ()

virtual void	Ogre::OverlaySystem::renderQueueStarted (uint8 queueGroupId, const String &invocation, bool &skipThisInvocation)

void	Ogre::OverlayProfileSessionListener::setOverlayDimensions (Real width, Real height)
	Set the size of the profiler overlay, in pixels. More...

void	Ogre::OverlayProfileSessionListener::setOverlayPosition (Real left, Real top)
	Set the position of the profiler overlay, in pixels. More...

Variables
Real	Ogre::OverlayProfileSessionListener::mBarHeight
	The height of each bar. More...

Real	Ogre::OverlayProfileSessionListener::mBarIndent
	The size of the indent for each profile display bar. More...

Real	Ogre::OverlayProfileSessionListener::mBarLineWidth
	The width of the min, avg, and max lines in a profile display. More...

Real	Ogre::OverlayProfileSessionListener::mBarSpacing
	The distance between bars. More...

FontManager *	Ogre::OverlaySystem::mFontManager

Real	Ogre::OverlayProfileSessionListener::mGuiBorderWidth
	The width of the border between the profile window and each bar. More...

Real	Ogre::OverlayProfileSessionListener::mGuiHeight
	The height of the stats window. More...

Real	Ogre::OverlayProfileSessionListener::mGuiLeft
	The horz position of the stats window. More...

Real	Ogre::OverlayProfileSessionListener::mGuiTop
	The vertical position of the stats window. More...

Real	Ogre::OverlayProfileSessionListener::mGuiWidth
	The width of the stats window. More...

uint	Ogre::OverlayProfileSessionListener::mMaxDisplayProfiles
	The max number of profiles we can display. More...

Overlay *	Ogre::OverlayProfileSessionListener::mOverlay
	The overlay which contains our profiler results display. More...

OverlayManager *	Ogre::OverlaySystem::mOverlayManager

ProfileBarList	Ogre::OverlayProfileSessionListener::mProfileBars
	Holds the display bars for each profile results. More...

OverlayContainer *	Ogre::OverlayProfileSessionListener::mProfileGui
	The window that displays the profiler results. More...

Detailed Description

Macro Definition Documentation

#define OGRE_DEREF_DISPLAYSTRING_ITERATOR ( it ) *it

Definition at line 54 of file OgreOverlayElement.h.

Typedef Documentation

typedef String Ogre::DisplayString

Definition at line 53 of file OgreOverlayElement.h.

typedef list<OverlayElement*>::type Ogre::OverlayProfileSessionListener::ProfileBarList

private

Definition at line 78 of file OgreOverlayProfileSessionListener.h.

Enumeration Type Documentation

enum Ogre::GuiHorizontalAlignment

Enum describing where '0' is in relation to the parent in the horizontal dimension.

Remarks: Affects how 'left' is interpreted.

Enumerator
GHA_LEFT
GHA_CENTER
GHA_RIGHT

Definition at line 71 of file OgreOverlayElement.h.

enum Ogre::GuiMetricsMode

Enum describing how the position / size of an element is to be recorded.

Enumerator
GMM_RELATIVE	'left', 'top', 'height' and 'width' are parametrics from 0.0 to 1.0
GMM_PIXELS	Positions & sizes are in absolute pixels.
GMM_RELATIVE_ASPECT_ADJUSTED	Positions & sizes are in virtual pixels.

Definition at line 58 of file OgreOverlayElement.h.

enum Ogre::GuiVerticalAlignment

Enum describing where '0' is in relation to the parent in the vertical dimension.

Remarks: Affects how 'top' is interpreted.

Enumerator
GVA_TOP
GVA_CENTER
GVA_BOTTOM

Definition at line 80 of file OgreOverlayElement.h.

Function Documentation

Ogre::OverlayProfileSessionListener::OverlayProfileSessionListener ( )

Ogre::OverlaySystem::OverlaySystem ( )

virtual Ogre::OverlayProfileSessionListener::~OverlayProfileSessionListener ( )

virtual

virtual Ogre::OverlaySystem::~OverlaySystem ( )

virtual

virtual void Ogre::OverlayProfileSessionListener::changeEnableState ( bool enabled )

virtual

See also: ProfileSessionListener::changeEnableState

Reimplemented from Ogre::ProfileSessionListener.

OverlayContainer* Ogre::OverlayProfileSessionListener::createContainer ( )

private

An internal function to create the container which will hold our display elements.

OverlayElement* Ogre::OverlayProfileSessionListener::createPanel	(	const String &	name,
		Real	width,
		Real	height,
		Real	top,
		Real	left,
		const String &	materialName,
		bool	show = `true`
	)

private

An internal function to create a panel.

OverlayElement* Ogre::OverlayProfileSessionListener::createTextArea	(	const String &	name,
		Real	width,
		Real	height,
		Real	top,
		Real	left,
		uint	fontSize,
		const String &	caption,
		bool	show = `true`
	)

private

An internal function to create a text area.

virtual void Ogre::OverlayProfileSessionListener::displayResults	(	const ProfileInstance &	instance,
		ulong	maxTotalFrameTime
	)

virtual

See also: ProfileSessionListener::displayResults

Reimplemented from Ogre::ProfileSessionListener.

void Ogre::OverlayProfileSessionListener::displayResults	(	ProfileInstance *	instance,
		ProfileBarList::const_iterator &	bIter,
		Real &	maxTimeMillisecs,
		Real &	newGuiHeight,
		int &	profileCount
	)

private

Prints the profiling results of each frame.

Remarks: Recursive, for all the little children.

virtual void Ogre::OverlayProfileSessionListener::finializeSession ( )

virtual

See also: ProfileSessionListener::finializeSession

Implements Ogre::ProfileSessionListener.

Real Ogre::OverlayProfileSessionListener::getOverlayHeight ( ) const

Real Ogre::OverlayProfileSessionListener::getOverlayLeft ( ) const

Real Ogre::OverlayProfileSessionListener::getOverlayTop ( ) const

Real Ogre::OverlayProfileSessionListener::getOverlayWidth ( ) const

virtual void Ogre::OverlayProfileSessionListener::initializeSession ( )

virtual

See also: ProfileSessionListener::initializeSession

Implements Ogre::ProfileSessionListener.

virtual void Ogre::OverlaySystem::renderQueueStarted	(	uint8	queueGroupId,
		const String &	invocation,
		bool &	skipThisInvocation
	)

virtual

See also: RenderQueueListener

Reimplemented from Ogre::RenderQueueListener.

void Ogre::OverlayProfileSessionListener::setOverlayDimensions	(	Real	width,
		Real	height
	)

Set the size of the profiler overlay, in pixels.

void Ogre::OverlayProfileSessionListener::setOverlayPosition	(	Real	left,
		Real	top
	)

Set the position of the profiler overlay, in pixels.

Variable Documentation

Real Ogre::OverlayProfileSessionListener::mBarHeight

private

The height of each bar.

Definition at line 105 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mBarIndent

private

The size of the indent for each profile display bar.

Definition at line 120 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mBarLineWidth

private

The width of the min, avg, and max lines in a profile display.

Definition at line 126 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mBarSpacing

private

The distance between bars.

Definition at line 129 of file OgreOverlayProfileSessionListener.h.

FontManager* Ogre::OverlaySystem::mFontManager

private

Definition at line 74 of file OgreOverlaySystem.h.

Real Ogre::OverlayProfileSessionListener::mGuiBorderWidth

private

The width of the border between the profile window and each bar.

Definition at line 123 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mGuiHeight

private

The height of the stats window.

Definition at line 108 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mGuiLeft

private

The horz position of the stats window.

Definition at line 114 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mGuiTop

private

The vertical position of the stats window.

Definition at line 117 of file OgreOverlayProfileSessionListener.h.

Real Ogre::OverlayProfileSessionListener::mGuiWidth

private

The width of the stats window.

Definition at line 111 of file OgreOverlayProfileSessionListener.h.

uint Ogre::OverlayProfileSessionListener::mMaxDisplayProfiles

private

The max number of profiles we can display.

Definition at line 132 of file OgreOverlayProfileSessionListener.h.

Overlay* Ogre::OverlayProfileSessionListener::mOverlay

private

The overlay which contains our profiler results display.

Definition at line 99 of file OgreOverlayProfileSessionListener.h.

OverlayManager* Ogre::OverlaySystem::mOverlayManager

private

Definition at line 73 of file OgreOverlaySystem.h.

ProfileBarList Ogre::OverlayProfileSessionListener::mProfileBars

private

Holds the display bars for each profile results.

Definition at line 96 of file OgreOverlayProfileSessionListener.h.

OverlayContainer* Ogre::OverlayProfileSessionListener::mProfileGui

private

The window that displays the profiler results.

Definition at line 102 of file OgreOverlayProfileSessionListener.h.

Namespaces

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation