Ogre::SceneManagerEnumerator Class Reference

Enumerates the SceneManager classes available to applications. More...

#include <OgreSceneManagerEnumerator.h>

Inheritance diagram for Ogre::SceneManagerEnumerator:

Public Types
typedef std::map< String, SceneManager * >	Instances
	Scene manager instances, indexed by instance name.
typedef ConstVectorIterator< MetaDataList >	MetaDataIterator
typedef std::vector< const SceneManagerMetaData * >	MetaDataList
	List of available scene manager types as meta data.
typedef MapIterator< Instances >	SceneManagerIterator

Public Member Functions
	SceneManagerEnumerator ()
	~SceneManagerEnumerator ()
void	addFactory (SceneManagerFactory *fact)
	Register a new SceneManagerFactory.
SceneManager *	createSceneManager (const String &typeName, const String &instanceName=BLANKSTRING)
	Create a SceneManager instance of a given type.
SceneManager *	createSceneManager (SceneTypeMask typeMask, const String &instanceName=BLANKSTRING)
void	destroySceneManager (SceneManager *sm)
	Destroy an instance of a SceneManager.
const MetaDataList &	getMetaData () const
	get all types of SceneManager available for construction
const SceneManagerMetaData *	getMetaData (const String &typeName) const
	Get more information about a given type of SceneManager.
MetaDataIterator	getMetaDataIterator (void) const
	Iterate over all types of SceneManager available for construction, providing some information about each one.
SceneManager *	getSceneManager (const String &instanceName) const
	Get an existing SceneManager instance that has already been created, identified by the instance name.
SceneManagerIterator	getSceneManagerIterator (void)
	Get an iterator over all the existing SceneManager instances.
const Instances &	getSceneManagers () const
	Get all the existing SceneManager instances.
bool	hasSceneManager (const String &instanceName) const
	Identify if a SceneManager instance already exists.
void	removeFactory (SceneManagerFactory *fact)
	Remove a SceneManagerFactory.
void	setRenderSystem (RenderSystem *rs)
	Notifies all SceneManagers of the destination rendering system.
void	shutdownAll (void)
	Utility method to control shutdown of the managers.
Public Member Functions inherited from Ogre::Singleton< SceneManagerEnumerator >
	Singleton (void)
	~Singleton (void)

Static Public Member Functions
static SceneManagerEnumerator &	getSingleton (void)
	Get the singleton instance.
static SceneManagerEnumerator *	getSingletonPtr (void)
	Get the singleton instance.
Static Public Member Functions inherited from Ogre::Singleton< SceneManagerEnumerator >
static SceneManagerEnumerator &	getSingleton (void)
	Get the singleton instance.
static SceneManagerEnumerator *	getSingletonPtr (void)
	Get the singleton instance.

Detailed Description

Enumerates the SceneManager classes available to applications.

Remarks

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.

In order to give applications easy access to these implementations, this class has a number of methods to create or retrieve a SceneManager which is appropriate to the scene type.

SceneManagers are created by SceneManagerFactory instances. New factories for new types of SceneManager can be registered with this class to make them available to clients.

Note that you can still plug in your own custom SceneManager without using a factory, should you choose, it's just not as flexible that way. Just instantiate your own SceneManager manually and use it directly.

Member Typedef Documentation

Instances

typedef std::map<String, SceneManager*> Ogre::SceneManagerEnumerator::Instances

Scene manager instances, indexed by instance name.

MetaDataList

typedef std::vector<const SceneManagerMetaData*> Ogre::SceneManagerEnumerator::MetaDataList

List of available scene manager types as meta data.

MetaDataIterator

typedef ConstVectorIterator<MetaDataList> Ogre::SceneManagerEnumerator::MetaDataIterator

SceneManagerIterator

typedef MapIterator<Instances> Ogre::SceneManagerEnumerator::SceneManagerIterator

Constructor & Destructor Documentation

SceneManagerEnumerator()

Ogre::SceneManagerEnumerator::SceneManagerEnumerator

(

)

~SceneManagerEnumerator()

Ogre::SceneManagerEnumerator::~SceneManagerEnumerator

(

)

Member Function Documentation

addFactory()

void Ogre::SceneManagerEnumerator::addFactory

(

SceneManagerFactory *

fact

)

Register a new SceneManagerFactory.

Remarks

Plugins should call this to register as new SceneManager providers.

removeFactory()

void Ogre::SceneManagerEnumerator::removeFactory

(

SceneManagerFactory *

fact

)

Remove a SceneManagerFactory.

getMetaData() [1/2]

const SceneManagerMetaData * Ogre::SceneManagerEnumerator::getMetaData

(

const String &

typeName

)

const

Get more information about a given type of SceneManager.

Remarks

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.

Parameters

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.

getMetaData() [2/2]

const MetaDataList & Ogre::SceneManagerEnumerator::getMetaData ( ) const

inline

get all types of SceneManager available for construction

providing some information about each one.

getMetaDataIterator()

MetaDataIterator Ogre::SceneManagerEnumerator::getMetaDataIterator

(

void

)

const

Iterate over all types of SceneManager available for construction, providing some information about each one.

Deprecated:

use getMetaData()

createSceneManager() [1/2]

SceneManager * Ogre::SceneManagerEnumerator::createSceneManager	(	const String &	typeName,
		const String &	instanceName = BLANKSTRING
	)

Create a SceneManager instance of a given type.

Remarks

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.

Note

This method throws an exception if the named type is not found.

Parameters

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.

createSceneManager() [2/2]

SceneManager * Ogre::SceneManagerEnumerator::createSceneManager ( SceneTypeMask  typeMask, const String &  instanceName = BLANKSTRING  )

inline

Deprecated:

obsolete API - SceneTypeMask leads to arbitrary results

References Ogre::DefaultSceneManagerFactory::FACTORY_TYPE_NAME.

destroySceneManager()

void Ogre::SceneManagerEnumerator::destroySceneManager

(

SceneManager *

sm

)

Destroy an instance of a SceneManager.

getSceneManager()

SceneManager * Ogre::SceneManagerEnumerator::getSceneManager

(

const String &

instanceName

)

const

Get an existing SceneManager instance that has already been created, identified by the instance name.

Parameters

instanceName

The name of the instance to retrieve.

hasSceneManager()

bool Ogre::SceneManagerEnumerator::hasSceneManager

(

const String &

instanceName

)

const

Identify if a SceneManager instance already exists.

Parameters

instanceName

The name of the instance to retrieve.

getSceneManagerIterator()

SceneManagerIterator Ogre::SceneManagerEnumerator::getSceneManagerIterator

(

void

)

Get an iterator over all the existing SceneManager instances.

Deprecated:

use getSceneManagers() instead

getSceneManagers()

const Instances & Ogre::SceneManagerEnumerator::getSceneManagers

(

)

const

Get all the existing SceneManager instances.

setRenderSystem()

void Ogre::SceneManagerEnumerator::setRenderSystem

(

RenderSystem *

rs

)

Notifies all SceneManagers of the destination rendering system.

shutdownAll()

void Ogre::SceneManagerEnumerator::shutdownAll

(

void

)

Utility method to control shutdown of the managers.

getSingleton()

static SceneManagerEnumerator & Ogre::SceneManagerEnumerator::getSingleton ( void  )

static

Get the singleton instance.

getSingletonPtr()

static SceneManagerEnumerator * Ogre::SceneManagerEnumerator::getSingletonPtr ( void  )

static

Get the singleton instance.

---

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

• OgreSceneManagerEnumerator.h