#include <OgreOverlayManager.h>
Public Types | |||||||
| typedef std::map < String, Overlay * > | OverlayMap | ||||||
| typedef std::map < String, OverlayElement * > | ElementMap | ||||||
| typedef MapIterator < OverlayMap > | OverlayMapIterator | ||||||
| typedef MapIterator < ElementMap > | TemplateIterator | ||||||
Public Member Functions | |||||||
| OverlayManager () | |||||||
| virtual | ~OverlayManager () | ||||||
| const StringVector & | getScriptPatterns (void) const | ||||||
| Gets the file patterns which should be used to find scripts for this class.
| |||||||
| void | parseScript (DataStreamPtr &stream, const String &groupName) | ||||||
| Parse a script file.
| |||||||
| Real | getLoadingOrder (void) const | ||||||
| Gets the relative loading order of scripts of this type.
| |||||||
| 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 | ||||||
| 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. | |||||||
| 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. | |||||||
| 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 | ||||||
Static Public Member Functions | |||||||
| static OverlayManager & | getSingleton (void) | ||||||
| Override standard Singleton retrieval. | |||||||
| static OverlayManager * | getSingletonPtr (void) | ||||||
| Override standard Singleton retrieval. | |||||||
Protected Types | |||||||
| typedef std::map < String, OverlayElementFactory * > | FactoryMap | ||||||
| typedef std::set < String > | 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) | ||||||
| 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 | ||||||
| FactoryMap | mFactories | ||||||
| ElementMap | mInstances | ||||||
| ElementMap | mTemplates | ||||||
| LoadedScripts | mLoadedScripts | ||||||
Static Protected Attributes | |||||||
| static T * | ms_Singleton | ||||||
Alo manages the creation of OverlayContainers and OverlayElements, used for non-interactive 2D elements such as HUDs.
Definition at line 45 of file OgreOverlayManager.h.
| typedef std::map<String, Overlay*> Ogre::OverlayManager::OverlayMap |
Definition at line 48 of file OgreOverlayManager.h.
| typedef std::map<String, OverlayElement*> Ogre::OverlayManager::ElementMap |
Definition at line 49 of file OgreOverlayManager.h.
typedef std::map<String, OverlayElementFactory*> Ogre::OverlayManager::FactoryMap [protected] |
Definition at line 67 of file OgreOverlayManager.h.
typedef std::set<String> Ogre::OverlayManager::LoadedScripts [protected] |
Definition at line 73 of file OgreOverlayManager.h.
Definition at line 114 of file OgreOverlayManager.h.
Definition at line 184 of file OgreOverlayManager.h.
| Ogre::OverlayManager::OverlayManager | ( | ) |
| virtual Ogre::OverlayManager::~OverlayManager | ( | ) | [virtual] |
| 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::parseElementAttrib | ( | const String & | line, | |
| Overlay * | pOverlay, | |||
| OverlayElement * | pElement | |||
| ) | [protected] |
| void Ogre::OverlayManager::skipToNextCloseBrace | ( | DataStreamPtr & | chunk | ) | [protected] |
| void Ogre::OverlayManager::skipToNextOpenBrace | ( | DataStreamPtr & | chunk | ) | [protected] |
| bool Ogre::OverlayManager::parseChildren | ( | DataStreamPtr & | chunk, | |
| const String & | line, | |||
| Overlay * | pOverlay, | |||
| bool | isTemplate, | |||
| OverlayContainer * | parent = NULL | |||
| ) | [protected] |
| ElementMap& Ogre::OverlayManager::getElementMap | ( | bool | isTemplate | ) | [protected] |
| OverlayElement* Ogre::OverlayManager::createOverlayElementImpl | ( | const String & | typeName, | |
| const String & | instanceName, | |||
| ElementMap & | elementMap | |||
| ) | [protected] |
| OverlayElement* Ogre::OverlayManager::getOverlayElementImpl | ( | const String & | name, | |
| ElementMap & | elementMap | |||
| ) | [protected] |
| void Ogre::OverlayManager::destroyOverlayElementImpl | ( | const String & | instanceName, | |
| ElementMap & | elementMap | |||
| ) | [protected] |
| void Ogre::OverlayManager::destroyOverlayElementImpl | ( | OverlayElement * | pInstance, | |
| ElementMap & | elementMap | |||
| ) | [protected] |
| void Ogre::OverlayManager::destroyAllOverlayElementsImpl | ( | 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.
| 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.
| Real Ogre::OverlayManager::getLoadingOrder | ( | void | ) | const [virtual] |
Gets the relative loading order of scripts of this type.
Implements Ogre::ScriptLoader.
| 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.
| OverlayMapIterator Ogre::OverlayManager::getOverlayIterator | ( | void | ) |
| void Ogre::OverlayManager::_queueOverlaysForRendering | ( | Camera * | cam, | |
| RenderQueue * | pQueue, | |||
| Viewport * | vp | |||
| ) |
Internal method for queueing the visible overlays for rendering.
| bool Ogre::OverlayManager::hasViewportChanged | ( | void | ) | const |
Method for determining if the viewport has changed dimensions.
| int Ogre::OverlayManager::getViewportHeight | ( | void | ) | const |
Gets the height of the destination viewport in pixels.
| int Ogre::OverlayManager::getViewportWidth | ( | void | ) | const |
Gets the width of the destination viewport in pixels.
| Real Ogre::OverlayManager::getViewportAspectRatio | ( | void | ) | const |
| 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::getOverlayElement | ( | const String & | name, | |
| bool | isTemplate = false | |||
| ) |
Gets a reference to an existing element.
| 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::destroyAllOverlayElements | ( | bool | isTemplate = false |
) |
Destroys all the OverlayElement created so far.
| void Ogre::OverlayManager::addOverlayElementFactory | ( | OverlayElementFactory * | elemFactory | ) |
Registers a new OverlayElementFactory with this manager.
| OverlayElement* Ogre::OverlayManager::createOverlayElementFromTemplate | ( | const String & | templateName, | |
| const String & | typeName, | |||
| const String & | instanceName, | |||
| bool | isTemplate = false | |||
| ) |
| OverlayElement* Ogre::OverlayManager::cloneOverlayElementFromTemplate | ( | const String & | templateName, | |
| const String & | instanceName | |||
| ) |
The new object's name, and all of it's children, will be instanceName/orignalName.
| OverlayElement* Ogre::OverlayManager::createOverlayElementFromFactory | ( | const String & | typeName, | |
| const String & | instanceName | |||
| ) |
| TemplateIterator Ogre::OverlayManager::getTemplateIterator | ( | ) |
Returns an iterator over all templates in this manager.
Definition at line 186 of file OgreOverlayManager.h.
| bool Ogre::OverlayManager::isTemplate | ( | String | strName | ) | const |
Definition at line 191 of file OgreOverlayManager.h.
| static OverlayManager& Ogre::OverlayManager::getSingleton | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
| static OverlayManager* Ogre::OverlayManager::getSingletonPtr | ( | void | ) | [static] |
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< T >.
OverlayMap Ogre::OverlayManager::mOverlayMap [protected] |
Definition at line 51 of file OgreOverlayManager.h.
StringVector Ogre::OverlayManager::mScriptPatterns [protected] |
Definition at line 52 of file OgreOverlayManager.h.
int Ogre::OverlayManager::mLastViewportWidth [protected] |
Definition at line 61 of file OgreOverlayManager.h.
int Ogre::OverlayManager::mLastViewportHeight [protected] |
Definition at line 61 of file OgreOverlayManager.h.
bool Ogre::OverlayManager::mViewportDimensionsChanged [protected] |
Definition at line 62 of file OgreOverlayManager.h.
FactoryMap Ogre::OverlayManager::mFactories [protected] |
Definition at line 68 of file OgreOverlayManager.h.
ElementMap Ogre::OverlayManager::mInstances [protected] |
Definition at line 70 of file OgreOverlayManager.h.
ElementMap Ogre::OverlayManager::mTemplates [protected] |
Definition at line 71 of file OgreOverlayManager.h.
LoadedScripts Ogre::OverlayManager::mLoadedScripts [protected] |
Definition at line 74 of file OgreOverlayManager.h.
T* Ogre::Singleton< T >::ms_Singleton [static, protected, inherited] |
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:51:11 2008