Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
#include <OgreOverlayManager.h>
Public Types | |
typedef map< String, OverlayElement * >::type | ElementMap |
typedef map< String, OverlayElementFactory * > ::type | FactoryMap |
typedef map< String, Overlay * > ::type | OverlayMap |
typedef MapIterator< OverlayMap > | OverlayMapIterator |
typedef MapIterator< ElementMap > | TemplateIterator |
Public Member Functions | |
OverlayManager () | |
virtual | ~OverlayManager () |
void | _queueOverlaysForRendering (Camera *cam, RenderQueue *pQueue, Viewport *vp) |
Internal method for queueing the visible overlays for rendering. More... | |
void | addOverlayElementFactory (OverlayElementFactory *elemFactory) |
Registers a new OverlayElementFactory with this manager. More... | |
OverlayElement * | cloneOverlayElementFromTemplate (const String &templateName, const String &instanceName) |
Overlay * | create (const String &name) |
Create a new Overlay. More... | |
OverlayElement * | createOverlayElement (const String &typeName, const String &instanceName, bool isTemplate=false) |
Creates a new OverlayElement of the type requested. More... | |
OverlayElement * | createOverlayElementFromFactory (const String &typeName, const String &instanceName) |
OverlayElement * | createOverlayElementFromTemplate (const String &templateName, const String &typeName, const String &instanceName, bool isTemplate=false) |
void | destroy (const String &name) |
Destroys an existing overlay by name. More... | |
void | destroy (Overlay *overlay) |
Destroys an existing overlay. More... | |
void | destroyAll (void) |
Destroys all existing overlays. More... | |
void | destroyAllOverlayElements (bool isTemplate=false) |
Destroys all the OverlayElement created so far. More... | |
void | destroyOverlayElement (const String &instanceName, bool isTemplate=false) |
Destroys a OverlayElement. More... | |
void | destroyOverlayElement (OverlayElement *pInstance, bool isTemplate=false) |
Destroys a OverlayElement. More... | |
Overlay * | getByName (const String &name) |
Retrieve an Overlay by name. More... | |
Real | getLoadingOrder (void) const |
Gets the relative loading order of scripts of this type. More... | |
OverlayElement * | getOverlayElement (const String &name, bool isTemplate=false) |
Gets a reference to an existing element. More... | |
const FactoryMap & | getOverlayElementFactoryMap () const |
Get const access to the list of registered OverlayElement factories. More... | |
OverlayMapIterator | getOverlayIterator (void) |
const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this class. More... | |
TemplateIterator | getTemplateIterator () |
Returns an iterator over all templates in this manager. More... | |
Real | getViewportAspectRatio (void) const |
int | getViewportHeight (void) const |
Gets the height of the destination viewport in pixels. More... | |
OrientationMode | getViewportOrientationMode (void) const |
Gets the orientation mode of the destination viewport. More... | |
int | getViewportWidth (void) const |
Gets the width of the destination viewport in pixels. More... | |
bool | hasOverlayElement (const String &name, bool isTemplate=false) |
Tests if an element exists. More... | |
bool | hasViewportChanged (void) const |
Method for determining if the viewport has changed dimensions. More... | |
bool | isTemplate (String strName) const |
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) |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse a script file. More... | |
Static Public Member Functions | |
static OverlayManager & | getSingleton (void) |
Override standard Singleton retrieval. More... | |
static OverlayManager * | getSingletonPtr (void) |
Override standard Singleton retrieval. More... | |
Protected Types | |
typedef set< String >::type | LoadedScripts |
Static Protected Attributes | |
static OverlayManager * | msSingleton |
Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them.
Also manages the creation of OverlayContainers and OverlayElements, used for non-interactive 2D elements such as HUDs.
Definition at line 51 of file OgreOverlayManager.h.
typedef map<String, OverlayElement*>::type Ogre::OverlayManager::ElementMap |
Definition at line 55 of file OgreOverlayManager.h.
typedef map<String, OverlayElementFactory*>::type Ogre::OverlayManager::FactoryMap |
Definition at line 56 of file OgreOverlayManager.h.
|
protected |
Definition at line 80 of file OgreOverlayManager.h.
typedef map<String, Overlay*>::type Ogre::OverlayManager::OverlayMap |
Definition at line 54 of file OgreOverlayManager.h.
Definition at line 123 of file OgreOverlayManager.h.
Definition at line 203 of file OgreOverlayManager.h.
Ogre::OverlayManager::OverlayManager | ( | ) |
|
virtual |
void Ogre::OverlayManager::_queueOverlaysForRendering | ( | Camera * | cam, |
RenderQueue * | pQueue, | ||
Viewport * | vp | ||
) |
Internal method for queueing the visible overlays for rendering.
void Ogre::OverlayManager::addOverlayElementFactory | ( | OverlayElementFactory * | elemFactory | ) |
Registers a new OverlayElementFactory with this manager.
OverlayElement* Ogre::OverlayManager::cloneOverlayElementFromTemplate | ( | const String & | templateName, |
const String & | instanceName | ||
) |
OverlayElement* Ogre::OverlayManager::createOverlayElement | ( | const String & | typeName, |
const String & | instanceName, | ||
bool | isTemplate = false |
||
) |
Creates a new OverlayElement of the type requested.
typeName | The type of element to create. |
instanceName | The name to give the new instance. |
OverlayElement* Ogre::OverlayManager::createOverlayElementFromFactory | ( | const String & | typeName, |
const String & | instanceName | ||
) |
OverlayElement* Ogre::OverlayManager::createOverlayElementFromTemplate | ( | const String & | templateName, |
const String & | typeName, | ||
const String & | instanceName, | ||
bool | isTemplate = false |
||
) |
|
protected |
void Ogre::OverlayManager::destroy | ( | const String & | name | ) |
Destroys an existing overlay by name.
void Ogre::OverlayManager::destroy | ( | Overlay * | overlay | ) |
Destroys an existing overlay.
void Ogre::OverlayManager::destroyAll | ( | void | ) |
Destroys all existing overlays.
void Ogre::OverlayManager::destroyAllOverlayElements | ( | bool | isTemplate = false | ) |
Destroys all the OverlayElement created so far.
|
protected |
void Ogre::OverlayManager::destroyOverlayElement | ( | const String & | instanceName, |
bool | isTemplate = false |
||
) |
Destroys a OverlayElement.
void Ogre::OverlayManager::destroyOverlayElement | ( | OverlayElement * | pInstance, |
bool | isTemplate = false |
||
) |
Destroys a OverlayElement.
|
protected |
|
protected |
|
protected |
|
virtual |
Gets the relative loading order of scripts of this type.
Implements Ogre::ScriptLoader.
OverlayElement* Ogre::OverlayManager::getOverlayElement | ( | const String & | name, |
bool | isTemplate = false |
||
) |
Gets a reference to an existing element.
|
inline |
Get const access to the list of registered OverlayElement factories.
Definition at line 189 of file OgreOverlayManager.h.
|
protected |
OverlayMapIterator Ogre::OverlayManager::getOverlayIterator | ( | void | ) |
|
virtual |
Gets the file patterns which should be used to find scripts for this class.
Implements Ogre::ScriptLoader.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
inline |
Returns an iterator over all templates in this manager.
Definition at line 205 of file OgreOverlayManager.h.
Real Ogre::OverlayManager::getViewportAspectRatio | ( | void | ) | const |
int Ogre::OverlayManager::getViewportHeight | ( | void | ) | const |
Gets the height of the destination viewport in pixels.
OrientationMode Ogre::OverlayManager::getViewportOrientationMode | ( | void | ) | const |
Gets the orientation mode of the destination viewport.
int Ogre::OverlayManager::getViewportWidth | ( | void | ) | const |
Gets the width of the destination viewport in pixels.
bool Ogre::OverlayManager::hasOverlayElement | ( | const String & | name, |
bool | isTemplate = false |
||
) |
Tests if an element exists.
|
protected |
bool Ogre::OverlayManager::hasViewportChanged | ( | void | ) | const |
Method for determining if the viewport has changed dimensions.
|
inline |
Definition at line 210 of file OgreOverlayManager.h.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
protected |
|
protected |
|
protected |
|
virtual |
Parse a script file.
stream | Weak reference to a data stream which is the source of the script |
groupName | The name of a resource group which should be used if any resources are created during the parse of this script. |
Implements Ogre::ScriptLoader.
|
protected |
|
protected |
|
protected |
Definition at line 75 of file OgreOverlayManager.h.
|
protected |
Definition at line 77 of file OgreOverlayManager.h.
|
protected |
Definition at line 68 of file OgreOverlayManager.h.
|
protected |
Definition at line 70 of file OgreOverlayManager.h.
|
protected |
Definition at line 68 of file OgreOverlayManager.h.
|
protected |
Definition at line 81 of file OgreOverlayManager.h.
|
protected |
Definition at line 58 of file OgreOverlayManager.h.
|
protected |
Definition at line 59 of file OgreOverlayManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protected |
Definition at line 78 of file OgreOverlayManager.h.
|
protected |
Definition at line 69 of file OgreOverlayManager.h.