---

Ogre::ParticleAffectorFactory Class Reference

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

#include <OgreParticleAffectorFactory.h>

Inheritance diagram for Ogre::ParticleAffectorFactory:

List of all members.

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

---

Detailed Description

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

Remarks:

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

ParticleAffectorFactory subclasses must allow the creation and destruction of ParticleAffector subclasses. They must also be registered with the ParticleSystemManager. All factories have a name which identifies them, examples might be 'force_vector', 'attractor', or 'fader', and these can be also be used from particle system scripts.

---

Constructor & Destructor Documentation

Ogre::ParticleAffectorFactory::ParticleAffectorFactory (    )  [inline]

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

---

Member Function Documentation

virtual ParticleAffector* Ogre::ParticleAffectorFactory::createAffector (  void    )  [pure virtual]

Creates a new affector instance. Remarks: The subclass MUST add a pointer to the created instance to mAffectors. Implemented in Ogre::ColourFaderAffectorFactory.

virtual void Ogre::ParticleAffectorFactory::destroyAffector (  ParticleAffector *    e )  [inline, virtual]

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

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

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

---

Member Data Documentation

std::vector<ParticleAffector*> Ogre::ParticleAffectorFactory::mAffectors [protected]

Copyright © 2002 by The OGRE Team