---

Ogre::ParticleEmitterFactory Class Reference

Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses. More...

#include <OgreParticleEmitterFactory.h>

Inheritance diagram for Ogre::ParticleEmitterFactory:

List of all members.

Public Methods
	ParticleEmitterFactory ()
virtual	~ParticleEmitterFactory ()
virtual String	getName ()=0
	Returns the name of the factory, the name which identifies the particle emitter type this factory creates. More...
virtual ParticleEmitter *	createEmitter (void)=0
	Creates a new emitter instance. More...
virtual void	destroyEmitter (ParticleEmitter *e)
	Destroys the emitter pointed to by the parameter (for early clean up if reauired). More...
Protected Attributes
std::vector< ParticleEmitter * >	mEmitters

---

Detailed Description

Abstract class defining the interface to be implemented by creators of ParticleEmitter subclasses.

Remarks:

Plugins or 3rd party applications can add new types of particle emitters to Ogre by creating subclasses of the ParticleEmitter class. Because multiple instances of these emitters may be required, a factory class to manage the instances is also required.

ParticleEmitterFactory subclasses must allow the creation and destruction of ParticleEmitter subclasses. They must also be registered with the ParticleSystemManager. All factories have a name which identifies them, examples might be 'point', 'cone', or 'box', and these can be also be used from particle system scripts.

---

Constructor & Destructor Documentation

Ogre::ParticleEmitterFactory::ParticleEmitterFactory (    )  [inline]

virtual Ogre::ParticleEmitterFactory::~ParticleEmitterFactory (    )  [inline, virtual]

---

Member Function Documentation

virtual ParticleEmitter* Ogre::ParticleEmitterFactory::createEmitter (  void    )  [pure virtual]

Creates a new emitter instance. Remarks: The subclass MUST add a pointer to the created instance to mEmitters. Implemented in Ogre::BoxEmitterFactory.

virtual void Ogre::ParticleEmitterFactory::destroyEmitter (  ParticleEmitter *    e )  [inline, virtual]

Destroys the emitter pointed to by the parameter (for early clean up if reauired).

virtual String Ogre::ParticleEmitterFactory::getName (    )  [pure virtual]

Returns the name of the factory, the name which identifies the particle emitter type this factory creates. Implemented in Ogre::BoxEmitterFactory.

---

Member Data Documentation

std::vector<ParticleEmitter*> Ogre::ParticleEmitterFactory::mEmitters [protected]

Copyright © 2002 by The OGRE Team