OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
Enumerates the SceneManager classes available to applications. More...
#include <OgreSceneManagerEnumerator.h>
Public Types | |
typedef std::map< String, SceneManager * > | Instances |
Scene manager instances, indexed by instance name. More... | |
typedef ConstVectorIterator< MetaDataList > | MetaDataIterator |
typedef std::vector< const SceneManagerMetaData * > | MetaDataList |
List of available scene manager types as meta data. More... | |
typedef MapIterator< Instances > | SceneManagerIterator |
Public Member Functions | |
SceneManagerEnumerator () | |
~SceneManagerEnumerator () | |
void | addFactory (SceneManagerFactory *fact) |
Register a new SceneManagerFactory. More... | |
SceneManager * | createSceneManager (const String &typeName, const String &instanceName=BLANKSTRING) |
Create a SceneManager instance of a given type. More... | |
SceneManager * | createSceneManager (uint16 typeMask, const String &instanceName=BLANKSTRING) |
void | destroySceneManager (SceneManager *sm) |
Destroy an instance of a SceneManager. More... | |
const MetaDataList & | getMetaData () const |
get all types of SceneManager available for construction More... | |
const SceneManagerMetaData * | getMetaData (const String &typeName) const |
Get more information about a given type of SceneManager. More... | |
MetaDataIterator | getMetaDataIterator (void) const |
Iterate over all types of SceneManager available for construction, providing some information about each one. More... | |
SceneManager * | getSceneManager (const String &instanceName) const |
Get an existing SceneManager instance that has already been created, identified by the instance name. More... | |
SceneManagerIterator | getSceneManagerIterator (void) |
Get an iterator over all the existing SceneManager instances. More... | |
const Instances & | getSceneManagers () const |
Get all the existing SceneManager instances. More... | |
bool | hasSceneManager (const String &instanceName) const |
Identify if a SceneManager instance already exists. More... | |
void | removeFactory (SceneManagerFactory *fact) |
Remove a SceneManagerFactory. More... | |
void | setRenderSystem (RenderSystem *rs) |
Notifies all SceneManagers of the destination rendering system. More... | |
void | shutdownAll (void) |
Utility method to control shutdown of the managers. More... | |
Public Member Functions inherited from Ogre::Singleton< SceneManagerEnumerator > | |
Singleton (void) | |
~Singleton (void) | |
Static Public Member Functions | |
static SceneManagerEnumerator & | getSingleton (void) |
Get the singleton instance. More... | |
static SceneManagerEnumerator * | getSingletonPtr (void) |
Get the singleton instance. More... | |
Static Public Member Functions inherited from Ogre::Singleton< SceneManagerEnumerator > | |
static SceneManagerEnumerator & | getSingleton (void) |
Get the singleton instance. More... | |
static SceneManagerEnumerator * | getSingletonPtr (void) |
Get the singleton instance. More... | |
Enumerates the SceneManager classes available to applications.
As described in the SceneManager class, SceneManagers are responsible for organising the scene and issuing rendering commands to the RenderSystem. Certain scene types can benefit from different rendering approaches, and it is intended that subclasses will be created to special case this.
typedef std::map<String, SceneManager*> Ogre::SceneManagerEnumerator::Instances |
Scene manager instances, indexed by instance name.
typedef std::vector<const SceneManagerMetaData*> Ogre::SceneManagerEnumerator::MetaDataList |
List of available scene manager types as meta data.
Ogre::SceneManagerEnumerator::SceneManagerEnumerator | ( | ) |
Ogre::SceneManagerEnumerator::~SceneManagerEnumerator | ( | ) |
void Ogre::SceneManagerEnumerator::addFactory | ( | SceneManagerFactory * | fact | ) |
Register a new SceneManagerFactory.
Plugins should call this to register as new SceneManager providers.
void Ogre::SceneManagerEnumerator::removeFactory | ( | SceneManagerFactory * | fact | ) |
Remove a SceneManagerFactory.
const SceneManagerMetaData* Ogre::SceneManagerEnumerator::getMetaData | ( | const String & | typeName | ) | const |
Get more information about a given type of SceneManager.
The metadata returned tells you a few things about a given type of SceneManager, which can be created using a factory that has been registered already.
typeName | The type name of the SceneManager you want to enquire on. If you don't know the typeName already, you can iterate over the metadata for all types using getMetaDataIterator. |
|
inline |
get all types of SceneManager available for construction
providing some information about each one.
MetaDataIterator Ogre::SceneManagerEnumerator::getMetaDataIterator | ( | void | ) | const |
Iterate over all types of SceneManager available for construction, providing some information about each one.
SceneManager* Ogre::SceneManagerEnumerator::createSceneManager | ( | const String & | typeName, |
const String & | instanceName = BLANKSTRING |
||
) |
Create a SceneManager instance of a given type.
You can use this method to create a SceneManager instance of a given specific type. You may know this type already, or you may have discovered it by looking at the results from getMetaDataIterator.
typeName | String identifying a unique SceneManager type |
instanceName | Optional name to given the new instance that is created. If you leave this blank, an auto name will be assigned. |
|
inline |
References Ogre::DefaultSceneManagerFactory::FACTORY_TYPE_NAME.
void Ogre::SceneManagerEnumerator::destroySceneManager | ( | SceneManager * | sm | ) |
Destroy an instance of a SceneManager.
SceneManager* Ogre::SceneManagerEnumerator::getSceneManager | ( | const String & | instanceName | ) | const |
Get an existing SceneManager instance that has already been created, identified by the instance name.
instanceName | The name of the instance to retrieve. |
bool Ogre::SceneManagerEnumerator::hasSceneManager | ( | const String & | instanceName | ) | const |
Identify if a SceneManager instance already exists.
instanceName | The name of the instance to retrieve. |
SceneManagerIterator Ogre::SceneManagerEnumerator::getSceneManagerIterator | ( | void | ) |
Get an iterator over all the existing SceneManager instances.
const Instances& Ogre::SceneManagerEnumerator::getSceneManagers | ( | ) | const |
Get all the existing SceneManager instances.
void Ogre::SceneManagerEnumerator::setRenderSystem | ( | RenderSystem * | rs | ) |
Notifies all SceneManagers of the destination rendering system.
void Ogre::SceneManagerEnumerator::shutdownAll | ( | void | ) |
Utility method to control shutdown of the managers.
|
static |
Get the singleton instance.
|
static |
Get the singleton instance.