![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...
#include <OgreOverlayManager.h>
Inheritance diagram for Ogre::v1::OverlayManager: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 () | |
| ~OverlayManager () override | |
| void | _queueOverlaysForRendering (RenderQueue *pQueue, Viewport *vp) |
| Internal method for queueing the visible overlays for rendering. | |
| void | _releaseManualHardwareResources () |
| Notifies that hardware resources were lost. | |
| void | _restoreManualHardwareResources () |
| Notifies that hardware resources should be restored. | |
| void | addOverlayElementFactory (OverlayElementFactory *elemFactory) |
| Registers a new OverlayElementFactory with this manager. | |
| OverlayElement * | cloneOverlayElementFromTemplate (const String &templateName, const String &instanceName) |
| Overlay * | create (const String &name) |
| Create a new Overlay. | |
| OverlayElement * | createOverlayElement (const String &typeName, const String &instanceName, bool isTemplate=false) |
| Creates a new OverlayElement of the type requested. | |
| 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. | |
| void | destroy (Overlay *overlay) |
| Destroys an existing overlay. | |
| void | destroyAll () |
| Destroys all existing overlays. | |
| void | destroyAllOverlayElements (bool isTemplate=false) |
| Destroys all the OverlayElement created so far. | |
| void | destroyOverlayElement (const String &instanceName, bool isTemplate=false) |
| Destroys a OverlayElement. | |
| void | destroyOverlayElement (OverlayElement *pInstance, bool isTemplate=false) |
| Destroys a OverlayElement. | |
| Overlay * | getByName (const String &name) |
| Retrieve an Overlay by name. | |
| Real | getLoadingOrder () const override |
| Gets the relative loading order of scripts of this type. | |
| OverlayElement * | getOverlayElement (const String &name, bool isTemplate=false) |
| Gets a reference to an existing element. | |
| const FactoryMap & | getOverlayElementFactoryMap () const |
| Get const access to the list of registered OverlayElement factories. | |
| OverlayMapIterator | getOverlayIterator () |
| const StringVector & | getScriptPatterns () const override |
| Gets the file patterns which should be used to find scripts for this class. | |
| TemplateIterator | getTemplateIterator () |
| Returns an iterator over all templates in this manager. | |
| Real | getViewportAspectRatio () const |
| int | getViewportHeight () const |
| Gets the height of the destination viewport in pixels. | |
| int | getViewportWidth () const |
| Gets the width of the destination viewport in pixels. | |
| bool | hasOverlayElement (const String &name, bool isTemplate=false) |
| Tests if an element exists. | |
| bool | isTemplate (String strName) const |
| void | parseScript (DataStreamPtr &stream, const String &groupName) override |
| Parse a script file. | |
Public Member Functions inherited from Ogre::Singleton< OverlayManager > | |
| Singleton () | |
| ~Singleton () | |
Public Member Functions inherited from Ogre::ScriptLoader | |
| virtual | ~ScriptLoader () |
Static Public Member Functions | |
| static OverlayManager & | getSingleton () |
| Override standard Singleton retrieval. | |
| static OverlayManager * | getSingletonPtr () |
| Override standard Singleton retrieval. | |
Static Public Member Functions inherited from Ogre::Singleton< OverlayManager > | |
| static OverlayManager & | getSingleton () |
| static OverlayManager * | getSingletonPtr () |
Public Attributes | |
| uint8 | mDefaultRenderQueueId |
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.
| typedef map<String,OverlayElement*>::type Ogre::v1::OverlayManager::ElementMap |
| typedef map<String,OverlayElementFactory*>::type Ogre::v1::OverlayManager::FactoryMap |
| typedef map<String,Overlay*>::type Ogre::v1::OverlayManager::OverlayMap |
| Ogre::v1::OverlayManager::OverlayManager | ( | ) |
Referenced by getSingleton(), and getSingletonPtr().
|
override |
| void Ogre::v1::OverlayManager::_queueOverlaysForRendering | ( | RenderQueue * | pQueue, |
| Viewport * | vp ) |
Internal method for queueing the visible overlays for rendering.
| void Ogre::v1::OverlayManager::_releaseManualHardwareResources | ( | ) |
Notifies that hardware resources were lost.
| void Ogre::v1::OverlayManager::_restoreManualHardwareResources | ( | ) |
Notifies that hardware resources should be restored.
| void Ogre::v1::OverlayManager::addOverlayElementFactory | ( | OverlayElementFactory * | elemFactory | ) |
Registers a new OverlayElementFactory with this manager.
| OverlayElement * Ogre::v1::OverlayManager::cloneOverlayElementFromTemplate | ( | const String & | templateName, |
| const String & | instanceName ) |
| OverlayElement * Ogre::v1::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. |
References isTemplate().
| OverlayElement * Ogre::v1::OverlayManager::createOverlayElementFromFactory | ( | const String & | typeName, |
| const String & | instanceName ) |
| OverlayElement * Ogre::v1::OverlayManager::createOverlayElementFromTemplate | ( | const String & | templateName, |
| const String & | typeName, | ||
| const String & | instanceName, | ||
| bool | isTemplate = false ) |
References isTemplate().
| void Ogre::v1::OverlayManager::destroy | ( | const String & | name | ) |
Destroys an existing overlay by name.
| void Ogre::v1::OverlayManager::destroy | ( | Overlay * | overlay | ) |
Destroys an existing overlay.
| void Ogre::v1::OverlayManager::destroyAll | ( | ) |
Destroys all existing overlays.
| void Ogre::v1::OverlayManager::destroyAllOverlayElements | ( | bool | isTemplate = false | ) |
Destroys all the OverlayElement created so far.
References isTemplate().
| void Ogre::v1::OverlayManager::destroyOverlayElement | ( | const String & | instanceName, |
| bool | isTemplate = false ) |
Destroys a OverlayElement.
References isTemplate().
| void Ogre::v1::OverlayManager::destroyOverlayElement | ( | OverlayElement * | pInstance, |
| bool | isTemplate = false ) |
Destroys a OverlayElement.
References isTemplate().
|
overridevirtual |
Gets the relative loading order of scripts of this type.
Implements Ogre::ScriptLoader.
| OverlayElement * Ogre::v1::OverlayManager::getOverlayElement | ( | const String & | name, |
| bool | isTemplate = false ) |
Gets a reference to an existing element.
References isTemplate().
|
inline |
Get const access to the list of registered OverlayElement factories.
| OverlayMapIterator Ogre::v1::OverlayManager::getOverlayIterator | ( | ) |
|
overridevirtual |
Gets the file patterns which should be used to find scripts for this class.
Implements Ogre::ScriptLoader.
|
static |
Override standard Singleton retrieval.
References OverlayManager().
|
static |
Override standard Singleton retrieval.
References OverlayManager().
|
inline |
Returns an iterator over all templates in this manager.
| Real Ogre::v1::OverlayManager::getViewportAspectRatio | ( | ) | const |
| int Ogre::v1::OverlayManager::getViewportHeight | ( | ) | const |
Gets the height of the destination viewport in pixels.
| int Ogre::v1::OverlayManager::getViewportWidth | ( | ) | const |
Gets the width of the destination viewport in pixels.
| bool Ogre::v1::OverlayManager::hasOverlayElement | ( | const String & | name, |
| bool | isTemplate = false ) |
Tests if an element exists.
References isTemplate().
|
inline |
|
overridevirtual |
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.
| uint8 Ogre::v1::OverlayManager::mDefaultRenderQueueId |