OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OverlaySystem Class Reference

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

#include <OgreOverlaySystem.h>

+ Inheritance diagram for Ogre::OverlaySystem:
+ Collaboration diagram for Ogre::OverlaySystem:

Public Member Functions

 OverlaySystem ()
 
virtual ~OverlaySystem ()
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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...
 
virtual void renderQueueStarted (RenderQueue *rq, uint8 queueGroupId, const String &invocation, bool &skipThisInvocation)
 

Private Attributes

FontManagermFontManager
 
OverlayManagermOverlayManager
 

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

Definition at line 56 of file OgreOverlaySystem.h.

Member Function Documentation

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::RenderQueueListener::postRenderQueues ( )
inlinevirtualinherited

Event raised after all render queues are processed.

Definition at line 66 of file OgreRenderQueueListener.h.

virtual void Ogre::RenderQueueListener::preRenderQueues ( )
inlinevirtualinherited

Event raised before all render queues are processed.

Definition at line 63 of file OgreRenderQueueListener.h.

virtual void Ogre::RenderQueueListener::renderQueueEnded ( uint8  queueGroupId,
const String invocation,
bool &  repeatThisInvocation 
)
inlinevirtualinherited

Event raised after a queue group is rendered.

Remarks
This method is called by the SceneManager after each queue group is rendered.
Parameters
queueGroupIdThe id of the queue group which has just been rendered
invocationName of the invocation which is causing this to be called (
See also
RenderQueueInvocation)
Parameters
repeatThisInvocationA boolean passed by reference which is by default set to false. If the event sets this to true, the queue which has just been rendered will be repeated, and the renderQueueStarted and renderQueueEnded events will also be fired for it again.

Definition at line 96 of file OgreRenderQueueListener.h.


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