Ogre::OverlayManager Class Reference
Core » Overlays

Manages Overlay objects, parsing them from .overlay files and storing a lookup library of them. More...

`#include <OgreOverlayManager.h>`

Inheritance diagram for Ogre::OverlayManager:
[legend]

## 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

## Protected Member Functions

OverlayElement * | createOverlayElementImpl (const String &typeName, const String &instanceName, ElementMap &elementMap)
void | destroyAllOverlayElementsImpl (ElementMap &elementMap)
void | destroyOverlayElementImpl (const String &instanceName, ElementMap &elementMap)
void | destroyOverlayElementImpl (OverlayElement *pInstance, ElementMap &elementMap)
ElementMap & | getElementMap (bool isTemplate)
OverlayElement * | getOverlayElementImpl (const String &name, ElementMap &elementMap)
bool | hasOverlayElementImpl (const String &name, ElementMap &elementMap)
void | parseAttrib (const String &line, Overlay *pOverlay)
bool | parseChildren (DataStreamPtr &chunk, const String &line, Overlay *pOverlay, bool isTemplate, OverlayContainer *parent=NULL)
void | parseElementAttrib (const String &line, Overlay *pOverlay, OverlayElement *pElement)
void | parseNewElement (DataStreamPtr &chunk, String &elemType, String &elemName, bool isContainer, Overlay *pOverlay, bool isTemplate, String templateName=String(""), OverlayContainer *container=0)
void | skipToNextCloseBrace (DataStreamPtr &chunk)
void | skipToNextOpenBrace (DataStreamPtr &chunk)

## Protected Attributes

FactoryMap | mFactories
ElementMap | mInstances
int | mLastViewportHeight
OrientationMode | mLastViewportOrientationMode
int | mLastViewportWidth
LoadedScripts | mLoadedScripts
OverlayMap | mOverlayMap
StringVector | mScriptPatterns
ElementMap | mTemplates
bool | mViewportDimensionsChanged

## Static Protected Attributes

static OverlayManager * | msSingleton

## Detailed Description

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.

## Member Typedef Documentation

## ElementMap

typedef map<String, OverlayElement*>::type Ogre::OverlayManager::ElementMap

Definition at line 55 of file OgreOverlayManager.h.

## FactoryMap

typedef map<String, OverlayElementFactory*>::type Ogre::OverlayManager::FactoryMap

Definition at line 56 of file OgreOverlayManager.h.

## LoadedScripts

typedef set<String>::type Ogre::OverlayManager::LoadedScripts

protected

Definition at line 80 of file OgreOverlayManager.h.

## OverlayMap

typedef map<String, Overlay*>::type Ogre::OverlayManager::OverlayMap

Definition at line 54 of file OgreOverlayManager.h.

## OverlayMapIterator

typedef MapIterator<OverlayMap> Ogre::OverlayManager::OverlayMapIterator

Definition at line 123 of file OgreOverlayManager.h.

## TemplateIterator

typedef MapIterator<ElementMap> Ogre::OverlayManager::TemplateIterator

Definition at line 203 of file OgreOverlayManager.h.

## Constructor & Destructor Documentation

## OverlayManager()

Ogre::OverlayManager::OverlayManager | ( |  | ) |

## ~OverlayManager()

virtual Ogre::OverlayManager::~OverlayManager | ( |  | ) |

virtual

## Member Function Documentation

## _queueOverlaysForRendering()

void Ogre::OverlayManager::_queueOverlaysForRendering | ( | Camera * | cam,
|  | RenderQueue * | pQueue,
|  | Viewport * | vp
| ) |  |

Internal method for queueing the visible overlays for rendering.

## addOverlayElementFactory()

void Ogre::OverlayManager::addOverlayElementFactory | ( | OverlayElementFactory * | elemFactory | ) |

Registers a new OverlayElementFactory with this manager.

Remarks
  Should be used by plugins or other apps wishing to provide a new OverlayElement subclass.

## cloneOverlayElementFromTemplate()

OverlayElement* Ogre::OverlayManager::cloneOverlayElementFromTemplate | ( | const String & | templateName,
|  | const String & | instanceName
| ) |  |

Remarks
  Creates a new OverlayElement object from the specified template name. The new object's name, and all of it's children, will be instanceName/orignalName.

## create()

Overlay* Ogre::OverlayManager::create | ( | const String & | name | ) |

Create a new Overlay.

## createOverlayElement()

OverlayElement* Ogre::OverlayManager::createOverlayElement | ( | const String & | typeName,
|  | const String & | instanceName,
|  | bool | isTemplate = `false`
| ) |  |

Creates a new OverlayElement of the type requested.

Remarks
  The type of element to create is passed in as a string because this allows plugins to register new types of component.

Parameters

  typeName | The type of element to create.
  instanceName | The name to give the new instance.

## createOverlayElementFromFactory()

OverlayElement* Ogre::OverlayManager::createOverlayElementFromFactory | ( | const String & | typeName,
|  | const String & | instanceName
| ) |  |

## createOverlayElementFromTemplate()

OverlayElement* Ogre::OverlayManager::createOverlayElementFromTemplate | ( | const String & | templateName,
|  | const String & | typeName,
|  | const String & | instanceName,
|  | bool | isTemplate = `false`
| ) |  |

## createOverlayElementImpl()

OverlayElement* Ogre::OverlayManager::createOverlayElementImpl | ( | const String & | typeName,
|  | const String & | instanceName,
|  | ElementMap & | elementMap
| ) |  |

protected

## destroy() [1/2]

void Ogre::OverlayManager::destroy | ( | const String & | name | ) |

Destroys an existing overlay by name.

## destroy() [2/2]

void Ogre::OverlayManager::destroy | ( | Overlay * | overlay | ) |

Destroys an existing overlay.

## destroyAll()

void Ogre::OverlayManager::destroyAll | ( | void |  | ) |

Destroys all existing overlays.

## destroyAllOverlayElements()

void Ogre::OverlayManager::destroyAllOverlayElements | ( | bool | isTemplate = `false` | ) |

Destroys all the OverlayElement created so far.

Remarks
  Best to leave this to the engine to call internally, there should rarely be a need to call it yourself.

## destroyAllOverlayElementsImpl()

void Ogre::OverlayManager::destroyAllOverlayElementsImpl | ( | ElementMap & | elementMap | ) |

protected

## destroyOverlayElement() [1/2]

void Ogre::OverlayManager::destroyOverlayElement | ( | const String & | instanceName,
|  | bool | isTemplate = `false`
| ) |  |

Destroys a OverlayElement.

Remarks
  Make sure you're not still using this in an Overlay. If in doubt, let OGRE destroy elements on shutdown.

## destroyOverlayElement() [2/2]

void Ogre::OverlayManager::destroyOverlayElement | ( | OverlayElement * | pInstance,
|  | bool | isTemplate = `false`
| ) |  |

Destroys a OverlayElement.

Remarks
  Make sure you're not still using this in an Overlay. If in doubt, let OGRE destroy elements on shutdown.

## destroyOverlayElementImpl() [1/2]

void Ogre::OverlayManager::destroyOverlayElementImpl | ( | const String & | instanceName,
|  | ElementMap & | elementMap
| ) |  |

protected

## destroyOverlayElementImpl() [2/2]

void Ogre::OverlayManager::destroyOverlayElementImpl | ( | OverlayElement * | pInstance,
|  | ElementMap & | elementMap
| ) |  |

protected

## getByName()

Overlay* Ogre::OverlayManager::getByName | ( | const String & | name | ) |

Retrieve an Overlay by name.

Returns
  A pointer to the Overlay, or 0 if not found

## getElementMap()

ElementMap& Ogre::OverlayManager::getElementMap | ( | bool | isTemplate | ) |

protected

## getLoadingOrder()

Real Ogre::OverlayManager::getLoadingOrder | ( | void |  | ) | const

virtual

Gets the relative loading order of scripts of this type.

Remarks
  There are dependencies between some kinds of scripts, and to enforce this all implementors of this interface must define a loading order.

Returns
  A value representing the relative loading order of these scripts compared to other script users, where higher values load later.

Implements Ogre::ScriptLoader.

## getOverlayElement()

OverlayElement* Ogre::OverlayManager::getOverlayElement | ( | const String & | name,
|  | bool | isTemplate = `false`
| ) |  |

Gets a reference to an existing element.

## getOverlayElementFactoryMap()

const FactoryMap& Ogre::OverlayManager::getOverlayElementFactoryMap | ( |  | ) | const

Get const access to the list of registered OverlayElement factories.

Definition at line 189 of file OgreOverlayManager.h.

## getOverlayElementImpl()

OverlayElement* Ogre::OverlayManager::getOverlayElementImpl | ( | const String & | name,
|  | ElementMap & | elementMap
| ) |  |

protected

## getOverlayIterator()

OverlayMapIterator Ogre::OverlayManager::getOverlayIterator | ( | void |  | ) |

## getScriptPatterns()

const StringVector& Ogre::OverlayManager::getScriptPatterns | ( | void |  | ) | const

virtual

Gets the file patterns which should be used to find scripts for this class.

Remarks
  This method is called when a resource group is loaded if you use ResourceGroupManager::_registerScriptLoader.

Returns
  A list of file patterns, in the order they should be searched in.

Implements Ogre::ScriptLoader.

## getSingleton()

static OverlayManager& Ogre::OverlayManager::getSingleton | ( | void |  | ) |

static

Override standard Singleton retrieval.

Remarks
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

## getSingletonPtr()

static OverlayManager* Ogre::OverlayManager::getSingletonPtr | ( | void |  | ) |

static

Override standard Singleton retrieval.

Remarks
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

## getTemplateIterator()

TemplateIterator Ogre::OverlayManager::getTemplateIterator | ( |  | ) |

Returns an iterator over all templates in this manager.

Definition at line 205 of file OgreOverlayManager.h.

## getViewportAspectRatio()

Real Ogre::OverlayManager::getViewportAspectRatio | ( | void |  | ) | const

## getViewportHeight()

int Ogre::OverlayManager::getViewportHeight | ( | void |  | ) | const

Gets the height of the destination viewport in pixels.

## getViewportOrientationMode()

OrientationMode Ogre::OverlayManager::getViewportOrientationMode | ( | void |  | ) | const

Gets the orientation mode of the destination viewport.

## getViewportWidth()

int Ogre::OverlayManager::getViewportWidth | ( | void |  | ) | const

Gets the width of the destination viewport in pixels.

## hasOverlayElement()

bool Ogre::OverlayManager::hasOverlayElement | ( | const String & | name,
|  | bool | isTemplate = `false`
| ) |  |

Tests if an element exists.

## hasOverlayElementImpl()

bool Ogre::OverlayManager::hasOverlayElementImpl | ( | const String & | name,
|  | ElementMap & | elementMap
| ) |  |

protected

## hasViewportChanged()

bool Ogre::OverlayManager::hasViewportChanged | ( | void |  | ) | const

Method for determining if the viewport has changed dimensions.

Remarks
  This is used by pixel-based OverlayElements to work out if they need to recalculate their sizes.

## isTemplate()

bool Ogre::OverlayManager::isTemplate | ( | String | strName | ) | const

Definition at line 210 of file OgreOverlayManager.h.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## parseAttrib()

void Ogre::OverlayManager::parseAttrib | ( | const String & | line,
|  | Overlay * | pOverlay
| ) |  |

protected

## parseChildren()

bool Ogre::OverlayManager::parseChildren | ( | DataStreamPtr & | chunk,
|  | const String & | line,
|  | Overlay * | pOverlay,
|  | bool | isTemplate,
|  | OverlayContainer * | parent = `NULL`
| ) |  |

protected

## parseElementAttrib()

void Ogre::OverlayManager::parseElementAttrib | ( | const String & | line,
|  | Overlay * | pOverlay,
|  | OverlayElement * | pElement
| ) |  |

protected

## parseNewElement()

void Ogre::OverlayManager::parseNewElement | ( | DataStreamPtr & | chunk,
|  | String & | elemType,
|  | String & | elemName,
|  | bool | isContainer,
|  | Overlay * | pOverlay,
|  | bool | isTemplate,
|  | String | templateName = `String("")`,
|  | OverlayContainer * | container = `0`
| ) |  |

protected

## parseScript()

void Ogre::OverlayManager::parseScript | ( | DataStreamPtr & | stream,
|  | const String & | groupName
| ) |  |

virtual

Parse a script file.

Parameters

  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.

## skipToNextCloseBrace()

void Ogre::OverlayManager::skipToNextCloseBrace | ( | DataStreamPtr & | chunk | ) |

protected

## skipToNextOpenBrace()

void Ogre::OverlayManager::skipToNextOpenBrace | ( | DataStreamPtr & | chunk | ) |

protected

## Member Data Documentation

## mFactories

FactoryMap Ogre::OverlayManager::mFactories

protected

Definition at line 75 of file OgreOverlayManager.h.

## mInstances

ElementMap Ogre::OverlayManager::mInstances

protected

Definition at line 77 of file OgreOverlayManager.h.

## mLastViewportHeight

int Ogre::OverlayManager::mLastViewportHeight

protected

Definition at line 68 of file OgreOverlayManager.h.

## mLastViewportOrientationMode

OrientationMode Ogre::OverlayManager::mLastViewportOrientationMode

protected

Definition at line 70 of file OgreOverlayManager.h.

## mLastViewportWidth

int Ogre::OverlayManager::mLastViewportWidth

protected

Definition at line 68 of file OgreOverlayManager.h.

## mLoadedScripts

LoadedScripts Ogre::OverlayManager::mLoadedScripts

protected

Definition at line 81 of file OgreOverlayManager.h.

## mOverlayMap

OverlayMap Ogre::OverlayManager::mOverlayMap

protected

Definition at line 58 of file OgreOverlayManager.h.

## mScriptPatterns

StringVector Ogre::OverlayManager::mScriptPatterns

protected

Definition at line 59 of file OgreOverlayManager.h.

## msSingleton

OverlayManager * Ogre::Singleton< OverlayManager >::msSingleton

static protected inherited

Definition at line 75 of file OgreSingleton.h.

## mTemplates

ElementMap Ogre::OverlayManager::mTemplates

protected

Definition at line 78 of file OgreOverlayManager.h.

## mViewportDimensionsChanged

bool Ogre::OverlayManager::mViewportDimensionsChanged

protected

Definition at line 69 of file OgreOverlayManager.h.

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

- OgreOverlayManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.