Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
#include <OgreOverlayManager.h>

Public Types | |
| typedef map< String, Overlay * > ::type | OverlayMap |
| typedef map< String, OverlayElement * >::type | ElementMap |
| typedef map< String, OverlayElementFactory * > ::type | FactoryMap |
| typedef MapIterator< OverlayMap > | OverlayMapIterator |
| typedef MapIterator< ElementMap > | TemplateIterator |
Public Member Functions | |
| OverlayManager () | |
| virtual | ~OverlayManager () |
| const StringVector & | getScriptPatterns (void) const |
| void | parseScript (DataStreamPtr &stream, const String &groupName) |
| Real | getLoadingOrder (void) const |
| Overlay * | create (const String &name) |
| Create a new Overlay. | |
| Overlay * | getByName (const String &name) |
| Retrieve an Overlay by name. | |
| void | destroy (const String &name) |
| Destroys an existing overlay by name. | |
| void | destroy (Overlay *overlay) |
| Destroys an existing overlay. | |
| void | destroyAll (void) |
| Destroys all existing overlays. | |
| OverlayMapIterator | getOverlayIterator (void) |
| void | _queueOverlaysForRendering (Camera *cam, RenderQueue *pQueue, Viewport *vp) |
| Internal method for queueing the visible overlays for rendering. | |
| bool | hasViewportChanged (void) const |
| Method for determining if the viewport has changed dimensions. | |
| int | getViewportHeight (void) const |
| Gets the height of the destination viewport in pixels. | |
| int | getViewportWidth (void) const |
| Gets the width of the destination viewport in pixels. | |
| Real | getViewportAspectRatio (void) const |
| OrientationMode | getViewportOrientationMode (void) const |
| Gets the orientation mode of the destination viewport. | |
| OverlayElement * | createOverlayElement (const String &typeName, const String &instanceName, bool isTemplate=false) |
| Creates a new OverlayElement of the type requested. | |
| OverlayElement * | getOverlayElement (const String &name, bool isTemplate=false) |
| Gets a reference to an existing element. | |
| bool | hasOverlayElement (const String &name, bool isTemplate=false) |
| Tests if an element exists. | |
| void | destroyOverlayElement (const String &instanceName, bool isTemplate=false) |
| Destroys a OverlayElement. | |
| void | destroyOverlayElement (OverlayElement *pInstance, bool isTemplate=false) |
| Destroys a OverlayElement. | |
| void | destroyAllOverlayElements (bool isTemplate=false) |
| Destroys all the OverlayElement created so far. | |
| void | addOverlayElementFactory (OverlayElementFactory *elemFactory) |
| Registers a new OverlayElementFactory with this manager. | |
| const FactoryMap & | getOverlayElementFactoryMap () const |
| Get const access to the list of registered OverlayElement factories. | |
| OverlayElement * | createOverlayElementFromTemplate (const String &templateName, const String &typeName, const String &instanceName, bool isTemplate=false) |
| OverlayElement * | cloneOverlayElementFromTemplate (const String &templateName, const String &instanceName) |
| OverlayElement * | createOverlayElementFromFactory (const String &typeName, const String &instanceName) |
| TemplateIterator | getTemplateIterator () |
| Returns an iterator over all templates in this manager. | |
| bool | isTemplate (String strName) const |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz) |
| 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 *) |
Static Public Member Functions | |
| static OverlayManager & | getSingleton (void) |
| Override standard Singleton retrieval. | |
| static OverlayManager * | getSingletonPtr (void) |
| Override standard Singleton retrieval. | |
Protected Types | |
| typedef set< String >::type | LoadedScripts |
Protected Member Functions | |
| void | parseNewElement (DataStreamPtr &chunk, String &elemType, String &elemName, bool isContainer, Overlay *pOverlay, bool isTemplate, String templateName=String(""), OverlayContainer *container=0) |
| void | parseAttrib (const String &line, Overlay *pOverlay) |
| void | parseElementAttrib (const String &line, Overlay *pOverlay, OverlayElement *pElement) |
| void | skipToNextCloseBrace (DataStreamPtr &chunk) |
| void | skipToNextOpenBrace (DataStreamPtr &chunk) |
| bool | parseChildren (DataStreamPtr &chunk, const String &line, Overlay *pOverlay, bool isTemplate, OverlayContainer *parent=NULL) |
| ElementMap & | getElementMap (bool isTemplate) |
| OverlayElement * | createOverlayElementImpl (const String &typeName, const String &instanceName, ElementMap &elementMap) |
| OverlayElement * | getOverlayElementImpl (const String &name, ElementMap &elementMap) |
| bool | hasOverlayElementImpl (const String &name, ElementMap &elementMap) |
| void | destroyOverlayElementImpl (const String &instanceName, ElementMap &elementMap) |
| void | destroyOverlayElementImpl (OverlayElement *pInstance, ElementMap &elementMap) |
| void | destroyAllOverlayElementsImpl (ElementMap &elementMap) |
Protected Attributes | |
| OverlayMap | mOverlayMap |
| StringVector | mScriptPatterns |
| int | mLastViewportWidth |
| int | mLastViewportHeight |
| bool | mViewportDimensionsChanged |
| OrientationMode | mLastViewportOrientationMode |
| FactoryMap | mFactories |
| ElementMap | mInstances |
| ElementMap | mTemplates |
| LoadedScripts | mLoadedScripts |
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.
typedef set<String>::type Ogre::OverlayManager::LoadedScripts [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.
| virtual 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 | ||
| ) |
| Overlay* Ogre::OverlayManager::create | ( | const String & | name | ) |
Create a new Overlay.
| 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 |
||
| ) |
| OverlayElement* Ogre::OverlayManager::createOverlayElementImpl | ( | const String & | typeName, |
| const String & | instanceName, | ||
| ElementMap & | elementMap | ||
| ) | [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.
| void Ogre::OverlayManager::destroyAllOverlayElementsImpl | ( | ElementMap & | elementMap | ) | [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.
| void Ogre::OverlayManager::destroyOverlayElementImpl | ( | const String & | instanceName, |
| ElementMap & | elementMap | ||
| ) | [protected] |
| void Ogre::OverlayManager::destroyOverlayElementImpl | ( | OverlayElement * | pInstance, |
| ElementMap & | elementMap | ||
| ) | [protected] |
| Overlay* Ogre::OverlayManager::getByName | ( | const String & | name | ) |
| ElementMap& Ogre::OverlayManager::getElementMap | ( | bool | isTemplate | ) | [protected] |
| Real Ogre::OverlayManager::getLoadingOrder | ( | void | ) | const [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.
| const FactoryMap& Ogre::OverlayManager::getOverlayElementFactoryMap | ( | ) | const |
Get const access to the list of registered OverlayElement factories.
Definition at line 189 of file OgreOverlayManager.h.
| OverlayElement* Ogre::OverlayManager::getOverlayElementImpl | ( | const String & | name, |
| ElementMap & | elementMap | ||
| ) | [protected] |
| const StringVector& Ogre::OverlayManager::getScriptPatterns | ( | void | ) | const [virtual] |
Gets the file patterns which should be used to find scripts for this class.
Implements Ogre::ScriptLoader.
| static OverlayManager& Ogre::OverlayManager::getSingleton | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< OverlayManager >.
| static OverlayManager* Ogre::OverlayManager::getSingletonPtr | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< OverlayManager >.
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.
| bool Ogre::OverlayManager::hasOverlayElementImpl | ( | const String & | name, |
| ElementMap & | elementMap | ||
| ) | [protected] |
| bool Ogre::OverlayManager::hasViewportChanged | ( | void | ) | const |
Method for determining if the viewport has changed dimensions.
| bool Ogre::OverlayManager::isTemplate | ( | String | strName | ) | const |
Definition at line 210 of file OgreOverlayManager.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| void * | |||
| ) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
| void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
| const char * | , | ||
| int | , | ||
| const char * | |||
| ) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| const char * | file, | ||
| int | line, | ||
| const char * | func | ||
| ) | [inherited] |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
| void * | ptr | ||
| ) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, |
| const char * | file, | ||
| int | line, | ||
| const char * | func | ||
| ) | [inherited] |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
| void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
| void Ogre::OverlayManager::parseAttrib | ( | const String & | line, |
| Overlay * | pOverlay | ||
| ) | [protected] |
| bool Ogre::OverlayManager::parseChildren | ( | DataStreamPtr & | chunk, |
| const String & | line, | ||
| Overlay * | pOverlay, | ||
| bool | isTemplate, | ||
| OverlayContainer * | parent = NULL |
||
| ) | [protected] |
| void Ogre::OverlayManager::parseElementAttrib | ( | const String & | line, |
| Overlay * | pOverlay, | ||
| OverlayElement * | pElement | ||
| ) | [protected] |
| void Ogre::OverlayManager::parseNewElement | ( | DataStreamPtr & | chunk, |
| String & | elemType, | ||
| String & | elemName, | ||
| bool | isContainer, | ||
| Overlay * | pOverlay, | ||
| bool | isTemplate, | ||
| String | templateName = String(""), |
||
| OverlayContainer * | container = 0 |
||
| ) | [protected] |
| void Ogre::OverlayManager::parseScript | ( | DataStreamPtr & | stream, |
| const String & | groupName | ||
| ) | [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.
| void Ogre::OverlayManager::skipToNextCloseBrace | ( | DataStreamPtr & | chunk | ) | [protected] |
| void Ogre::OverlayManager::skipToNextOpenBrace | ( | DataStreamPtr & | chunk | ) | [protected] |
FactoryMap Ogre::OverlayManager::mFactories [protected] |
Definition at line 75 of file OgreOverlayManager.h.
ElementMap Ogre::OverlayManager::mInstances [protected] |
Definition at line 77 of file OgreOverlayManager.h.
int Ogre::OverlayManager::mLastViewportHeight [protected] |
Definition at line 68 of file OgreOverlayManager.h.
Definition at line 70 of file OgreOverlayManager.h.
int Ogre::OverlayManager::mLastViewportWidth [protected] |
Definition at line 68 of file OgreOverlayManager.h.
LoadedScripts Ogre::OverlayManager::mLoadedScripts [protected] |
Definition at line 81 of file OgreOverlayManager.h.
OverlayMap Ogre::OverlayManager::mOverlayMap [protected] |
Definition at line 58 of file OgreOverlayManager.h.
StringVector Ogre::OverlayManager::mScriptPatterns [protected] |
Definition at line 59 of file OgreOverlayManager.h.
OverlayManager * Ogre::Singleton< OverlayManager >::msSingleton [static, protected, inherited] |
Definition at line 75 of file OgreSingleton.h.
ElementMap Ogre::OverlayManager::mTemplates [protected] |
Definition at line 78 of file OgreOverlayManager.h.
bool Ogre::OverlayManager::mViewportDimensionsChanged [protected] |
Definition at line 69 of file OgreOverlayManager.h.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:32