#include <OgreParticleAffector.h>
Inheritance diagram for Ogre::ParticleAffector:
Public Methods | |
virtual | ~ParticleAffector () |
Virtual destructor essential. More... | |
virtual void | _affectParticles (ParticleSystem *pSystem, Real timeElapsed)=0 |
Method called to allow the affector to 'do it's stuff' on all active particles in the system. More... | |
String | getType (void) |
Returns the name of the type of affector. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParameterList & | getParameters (void) |
Retrieves a list of parameters valid for this object. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual String | getParameter (const String &name) |
Generic parameter retrieval method. More... | |
virtual void | copyParametersTo (StringInterface *dest) |
Method for copying this object's parameters to another object. More... | |
Protected Methods | |
void | addBaseParameters (void) |
Internal method for setting up the basic parameter definitions for a subclass. More... | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. More... | |
Protected Attributes | |
String | mType |
Name of the type of affector, MUST be initialised by subclasses. More... | |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). More... | |
Static Protected Attributes | |
ParamDictionaryMap | msDictionary |
Dictionary of parameters. More... |
Because there are so many types of affectors you could use, OGRE chooses not to dictate the available types. It comes with some in-built, but allows plugins or applications to extend the affector types available. This is done by subclassing ParticleAffector to have the appropriate emission behaviour you want, and also creating a subclass of ParticleAffectorFactory which is responsible for creating instances of your new affector type. You register this factory with the ParticleSystemManager using addAffectorFactory, and from then on affectors of this type can be created either from code or through text particle scripts by naming the type.
This same approach is used for ParticleEmitters (which are the source of particles in a system). This means that OGRE is particularly flexible when it comes to creating particle system effects, with literally infinite combinations of affector and affector types, and paramters within those types.
|
Virtual destructor essential.
|
|
Method called to allow the affector to 'do it's stuff' on all active particles in the system.
Implemented in Ogre::ColourFaderAffector. |
|
Internal method for setting up the basic parameter definitions for a subclass.
|
|
Method for copying this object's parameters to another object.
|
|
Internal method for creating a parameter dictionary for the class, if it does not already exist.
|
|
Retrieves the parameter dictionary for this class.
|
|
Generic parameter retrieval method.
|
|
Retrieves a list of parameters valid for this object.
|
|
Returns the name of the type of affector.
|
|
Generic parameter setting method.
|
|
Class name for this instance to be used as a lookup (must be initialised by subclasses).
|
|
Dictionary of parameters.
|
|
Name of the type of affector, MUST be initialised by subclasses.
|
Copyright © 2002 by The OGRE Team