OGRE-Next  4.0.0unstable
Object-Oriented Graphics Rendering Engine
Overlays

Classes

class  Ogre::v1::BorderPanelOverlayElement
 A specialisation of the PanelOverlayElement to provide a panel with a border. More...
 
class  Ogre::v1::BorderPanelOverlayElementFactory
 Factory for creating BorderPanelOverlayElement instances. More...
 
class  Ogre::v1::BorderRenderable
 Class for rendering the border of a BorderPanelOverlayElement. More...
 
class  Ogre::v1::Overlay
 Represents a layer which is rendered on top of the 'normal' scene contents. More...
 
class  Ogre::v1::OverlayContainer
 A 2D element which contains other OverlayElement instances. More...
 
class  Ogre::v1::OverlayElement
 Abstract definition of a 2D element to be displayed in an Overlay. More...
 
class  Ogre::v1::OverlayElementFactory
 Defines the interface which all components wishing to supply OverlayElement subclasses must implement. More...
 
class  Ogre::v1::OverlayManager
 Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
 
class  Ogre::v1::OverlayProfileSessionListener
 Concrete impl. More...
 
class  Ogre::v1::OverlaySystem
 This class simplify initialization / finalization of the overlay system. More...
 
class  Ogre::v1::PanelOverlayElement
 OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...
 
class  Ogre::v1::PanelOverlayElementFactory
 Factory for creating PanelOverlayElement instances. More...
 
class  Ogre::v1::TextAreaOverlayElement
 This class implements an overlay element which contains simple unformatted text. More...
 
class  Ogre::v1::TextAreaOverlayElementFactory
 Factory for creating TextAreaOverlayElement instances. More...
 

Macros

#define OGRE_DEREF_DISPLAYSTRING_ITERATOR(it)   *it
 

Typedefs

typedef String Ogre::v1::DisplayString
 

Enumerations

enum  Ogre::v1::GuiHorizontalAlignment { Ogre::v1::GHA_LEFT , Ogre::v1::GHA_CENTER , Ogre::v1::GHA_RIGHT }
 Enum describing where '0' is in relation to the parent in the horizontal dimension. More...
 
enum  Ogre::v1::GuiMetricsMode { Ogre::v1::GMM_RELATIVE , Ogre::v1::GMM_PIXELS , Ogre::v1::GMM_RELATIVE_ASPECT_ADJUSTED }
 Enum describing how the position / size of an element is to be recorded. More...
 
enum  Ogre::v1::GuiVerticalAlignment { Ogre::v1::GVA_TOP , Ogre::v1::GVA_CENTER , Ogre::v1::GVA_BOTTOM }
 Enum describing where '0' is in relation to the parent in the vertical dimension. More...
 

Functions

 Ogre::v1::OverlayProfileSessionListener::OverlayProfileSessionListener ()
 
 Ogre::v1::OverlaySystem::OverlaySystem ()
 
 Ogre::v1::OverlayProfileSessionListener::~OverlayProfileSessionListener () override
 
 Ogre::v1::OverlaySystem::~OverlaySystem () override
 
void Ogre::v1::OverlayProfileSessionListener::changeEnableState (bool enabled) override
 
void Ogre::v1::OverlayProfileSessionListener::displayResults (const ProfileInstance &instance, uint64 maxTotalFrameTime) override
 
void Ogre::v1::OverlaySystem::eventOccurred (const String &eventName, const NameValuePairList *parameters) override
 
void Ogre::v1::OverlayProfileSessionListener::finializeSession () override
 
Real Ogre::v1::OverlayProfileSessionListener::getOverlayHeight () const
 
Real Ogre::v1::OverlayProfileSessionListener::getOverlayLeft () const
 
Real Ogre::v1::OverlayProfileSessionListener::getOverlayTop () const
 
Real Ogre::v1::OverlayProfileSessionListener::getOverlayWidth () const
 
void Ogre::v1::OverlayProfileSessionListener::initializeSession () override
 
void Ogre::v1::OverlaySystem::renderQueueStarted (RenderQueue *rq, uint8 queueGroupId, const String &invocation, bool &skipThisInvocation) override
 
void Ogre::v1::OverlayProfileSessionListener::setOverlayDimensions (Real width, Real height)
 Set the size of the profiler overlay, in pixels. More...
 
void Ogre::v1::OverlayProfileSessionListener::setOverlayPosition (Real left, Real top)
 Set the position of the profiler overlay, in pixels. More...
 

Detailed Description

Macro Definition Documentation

◆ OGRE_DEREF_DISPLAYSTRING_ITERATOR

#define OGRE_DEREF_DISPLAYSTRING_ITERATOR (   it)    *it

Typedef Documentation

◆ DisplayString

Enumeration Type Documentation

◆ 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 

◆ 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.

◆ 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 

Function Documentation

◆ OverlayProfileSessionListener()

Ogre::v1::OverlayProfileSessionListener::OverlayProfileSessionListener ( )

◆ OverlaySystem()

Ogre::v1::OverlaySystem::OverlaySystem ( )

◆ ~OverlayProfileSessionListener()

Ogre::v1::OverlayProfileSessionListener::~OverlayProfileSessionListener ( )
override

◆ ~OverlaySystem()

Ogre::v1::OverlaySystem::~OverlaySystem ( )
override

◆ changeEnableState()

void Ogre::v1::OverlayProfileSessionListener::changeEnableState ( bool  enabled)
overridevirtual

◆ displayResults()

void Ogre::v1::OverlayProfileSessionListener::displayResults ( const ProfileInstance instance,
uint64  maxTotalFrameTime 
)
overridevirtual

◆ eventOccurred()

void Ogre::v1::OverlaySystem::eventOccurred ( const String eventName,
const NameValuePairList parameters 
)
overridevirtual

◆ finializeSession()

void Ogre::v1::OverlayProfileSessionListener::finializeSession ( )
overridevirtual

◆ getOverlayHeight()

Real Ogre::v1::OverlayProfileSessionListener::getOverlayHeight ( ) const

◆ getOverlayLeft()

Real Ogre::v1::OverlayProfileSessionListener::getOverlayLeft ( ) const

◆ getOverlayTop()

Real Ogre::v1::OverlayProfileSessionListener::getOverlayTop ( ) const

◆ getOverlayWidth()

Real Ogre::v1::OverlayProfileSessionListener::getOverlayWidth ( ) const

◆ initializeSession()

void Ogre::v1::OverlayProfileSessionListener::initializeSession ( )
overridevirtual

◆ renderQueueStarted()

void Ogre::v1::OverlaySystem::renderQueueStarted ( RenderQueue rq,
uint8  queueGroupId,
const String invocation,
bool &  skipThisInvocation 
)
overridevirtual
See also
RenderQueueListener

Reimplemented from Ogre::RenderQueueListener.

◆ setOverlayDimensions()

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

Set the size of the profiler overlay, in pixels.

◆ setOverlayPosition()

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

Set the position of the profiler overlay, in pixels.