OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::OverlaySystem Class Reference

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

#include <OgreOverlaySystem.h>

+ Inheritance diagram for Ogre::OverlaySystem:

Public Member Functions

 OverlaySystem ()
 
virtual ~OverlaySystem ()
 
virtual void eventOccurred (const String &eventName, const NameValuePairList *parameters)
 
virtual void renderQueueStarted (uint8 queueGroupId, const String &invocation, bool &skipThisInvocation)
 
- Public Member Functions inherited from Ogre::Singleton< OverlaySystem >
 Singleton (void)
 
 ~Singleton (void)
 
- Public Member Functions inherited from Ogre::RenderQueueListener
virtual ~RenderQueueListener ()
 
virtual void postRenderQueues ()
 Event raised after all render queues are processed. More...
 
virtual void preRenderQueues ()
 Event raised before all render queues are processed. More...
 
virtual void renderQueueEnded (uint8 queueGroupId, const String &invocation, bool &repeatThisInvocation)
 Event raised after a queue group is rendered. More...
 
- Public Member Functions inherited from Ogre::RenderSystem::Listener
 Listener ()
 
virtual ~Listener ()
 

Static Public Member Functions

static OverlaySystemgetSingleton ()
 
static OverlaySystemgetSingletonPtr ()
 
- Static Public Member Functions inherited from Ogre::Singleton< OverlaySystem >
static OverlaySystemgetSingleton (void)
 Get the singleton instance. More...
 
static OverlaySystemgetSingletonPtr (void)
 Get the singleton instance. More...
 

Detailed Description

This class simplify initialization / finalization of the overlay system.

OGRE root did this steps before the overlay system transformed into a component.

Remarks
Before you create a concrete instance of the OverlaySystem the OGRE::Root must be created but not initialized. In the ctor all relevant systems are created and registered. The dtor must be called before you delete OGRE::Root. To make the overlays visible (= render into your viewports) you have to register this instance as a RenderQueueListener in your scenemanager(s).

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