OpenGUI::OgreFrameListener Class Reference

#include <Renderer_Ogre_Renderer.h>

Detailed Description

FrameListener that updates OpenGUI timing every frame.

An instance of this class is always created and managed by OgreRenderer.

During the "frameStarted" event this class will update OpenGUI's internal timer via System::updateTime(), then inject time delta events into each Screen that is auto timing via ScreenManager::updateTime().

Additionally, this object initiates automatic buffer reclamation processing at the end of frames via OgreRenderer::reclaimBufferMemory().

This FrameListener will always return true, and should never cause unintended exiting from Ogre::Root::startRendering()

Public Member Functions

virtual bool frameStarted (const Ogre::FrameEvent &evt)

performs the timing updates as specified in the class documentation

virtual bool frameEnded (const Ogre::FrameEvent &evt)

calls OgreRenderer::reclaimBufferMemory() once per frame

Private Member Functions

OgreFrameListener (OgreRenderer *renderer)

virtual ~OgreFrameListener ()

Private Attributes

OgreRenderer * mRenderer

Friends

class OgreRenderer

Constructor & Destructor Documentation

OpenGUI::OgreFrameListener::OgreFrameListener ( OgreRenderer * renderer ) [private]

OpenGUI::OgreFrameListener::~OgreFrameListener ( ) [private, virtual]

Member Function Documentation

bool OpenGUI::OgreFrameListener::frameEnded ( const Ogre::FrameEvent & evt ) [virtual]

calls OgreRenderer::reclaimBufferMemory() once per frame

bool OpenGUI::OgreFrameListener::frameStarted ( const Ogre::FrameEvent & evt ) [virtual]

performs the timing updates as specified in the class documentation

Note:
Because it is possible to have an OgreRenderer instance (containing an OgreFrameListener instance) without a complimenting OpenGUI::System, this automatic update process performs safety checks to ensure that each used Singleton exists before making the updates.

Friends And Related Function Documentation

friend class OgreRenderer [friend]

Member Data Documentation

OgreRenderer* OpenGUI::OgreFrameListener::mRenderer [private]

The documentation for this class was generated from the following files:


Public Member Functions
virtual bool	frameStarted (const Ogre::FrameEvent &evt)
	performs the timing updates as specified in the class documentation
virtual bool	frameEnded (const Ogre::FrameEvent &evt)
	calls OgreRenderer::reclaimBufferMemory() once per frame
Private Member Functions
	OgreFrameListener (OgreRenderer *renderer)
virtual	~OgreFrameListener ()
Private Attributes
OgreRenderer *	mRenderer
Friends
class	OgreRenderer