Ogre::ParticleSystemManager Class Reference

Manages particle systems, particle system scripts (templates) and the available emitter & affector factories. More...

#include <OgreParticleSystemManager.h>

Inheritance diagram for Ogre::ParticleSystemManager:

List of all members.

Public Types

typedef std::map< String,
ParticleSystem * > ParticleTemplateMap

typedef std::map< String,
ParticleAffectorFactory * > ParticleAffectorFactoryMap

typedef std::map< String,
ParticleEmitterFactory * > ParticleEmitterFactoryMap

typedef std::map< String,
ParticleSystemRendererFactory * > ParticleSystemRendererFactoryMap

typedef MapIterator< ParticleAffectorFactoryMap > ParticleAffectorFactoryIterator

typedef MapIterator< ParticleEmitterFactoryMap > ParticleEmitterFactoryIterator

typedef MapIterator< ParticleSystemRendererFactoryMap > ParticleRendererFactoryIterator

typedef MapIterator< ParticleTemplateMap > ParticleSystemTemplateIterator

Public Member Functions

ParticleSystemManager ()

virtual ~ParticleSystemManager ()

void addEmitterFactory (ParticleEmitterFactory *factory)

Adds a new 'factory' object for emitters to the list of available emitter types.

void addAffectorFactory (ParticleAffectorFactory *factory)

Adds a new 'factory' object for affectors to the list of available affector types.

void addRendererFactory (ParticleSystemRendererFactory *factory)

Registers a factory class for creating ParticleSystemRenderer instances.

void addTemplate (const String &name, ParticleSystem *sysTemplate)

Adds a new particle system template to the list of available templates.

ParticleSystem * createTemplate (const String &name, const String &resourceGroup)

Create a new particle system template.

ParticleSystem * getTemplate (const String &name)

Retrieves a particle system template for possible modification.

ParticleEmitter * _createEmitter (const String &emitterType, ParticleSystem *psys)

Internal method for creating a new emitter from a factory.

void _destroyEmitter (ParticleEmitter *emitter)

Internal method for destroying an emitter.

ParticleAffector * _createAffector (const String &affectorType, ParticleSystem *psys)

Internal method for creating a new affector from a factory.

void _destroyAffector (ParticleAffector *affector)

Internal method for destroying an affector.

ParticleSystemRenderer * _createRenderer (const String &rendererType)

Internal method for creating a new renderer from a factory.

void _destroyRenderer (ParticleSystemRenderer *renderer)

Internal method for destroying a renderer.

bool frameStarted (const FrameEvent &evt)

Frame event.

bool frameEnded (const FrameEvent &evt)

Frame event.

void _initialise (void)

Init method to be called by OGRE system.

const StringVector & getScriptPatterns (void) const

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.

void parseScript (DataStreamPtr &stream, const String &groupName)

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.

Real getLoadingOrder (void) const

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.

ParticleAffectorFactoryIterator getAffectorFactoryIterator (void)

Return an iterator over the affector factories currently registered.

ParticleEmitterFactoryIterator getEmitterFactoryIterator (void)

Return an iterator over the emitter factories currently registered.

ParticleRendererFactoryIterator getRendererFactoryIterator (void)

Return an iterator over the renderer factories currently registered.

ParticleSystemTemplateIterator getTemplateIterator (void)

Gets an iterator over the list of particle system templates.

ParticleSystemFactory * _getFactory (void)

Get an instance of ParticleSystemFactory (internal use).

Static Public Member Functions

ParticleSystemManager & getSingleton (void)

Override standard Singleton retrieval.

ParticleSystemManager * getSingletonPtr (void)

Override standard Singleton retrieval.