#include <OgreParticleAffector.h>
Public Member Functions | |
| ParticleAffector (ParticleSystem *parent) | |
| virtual | ~ParticleAffector () |
| Virtual destructor essential. | |
| virtual void | _initParticle (Particle *pParticle) |
| Method called to allow the affector to initialize all newly created particles in the system. | |
| 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. | |
| const String & | getType (void) const |
| Returns the name of the type of affector. | |
| ParamDictionary * | getParamDictionary (void) |
| Retrieves the parameter dictionary for this class. | |
| const ParamDictionary * | getParamDictionary (void) const |
| const ParameterList & | getParameters (void) const |
| Retrieves a list of parameters valid for this object. | |
| virtual bool | setParameter (const String &name, const String &value) |
| Generic parameter setting method. | |
| virtual void | setParameterList (const NameValuePairList ¶mList) |
| Generic multiple parameter setting method. | |
| virtual String | getParameter (const String &name) const |
| Generic parameter retrieval method. | |
| virtual void | copyParametersTo (StringInterface *dest) const |
| Method for copying this object's parameters to another object. | |
Static Public Member Functions | |
| static void | cleanupDictionary () |
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. | |
Protected Member Functions | |
| void | addBaseParameters (void) |
| Internal method for setting up the basic parameter definitions for a subclass. | |
| bool | createParamDictionary (const String &className) |
| Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
| String | mType |
| Name of the type of affector, MUST be initialised by subclasses. | |
| ParticleSystem * | mParent |
| String | mParamDictName |
| Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
| static ParamDictionaryMap | msDictionary |
| Dictionary of parameters. | |
Definition at line 58 of file OgreParticleAffector.h.
| Ogre::ParticleAffector::ParticleAffector | ( | ParticleSystem * | parent | ) |
Definition at line 76 of file OgreParticleAffector.h.
| virtual Ogre::ParticleAffector::~ParticleAffector | ( | ) | [virtual] |
Virtual destructor essential.
| void Ogre::ParticleAffector::addBaseParameters | ( | void | ) | [protected] |
Internal method for setting up the basic parameter definitions for a subclass.
Definition at line 72 of file OgreParticleAffector.h.
| virtual void Ogre::ParticleAffector::_initParticle | ( | Particle * | pParticle | ) | [virtual] |
Method called to allow the affector to initialize all newly created particles in the system.
| pParticle | Pointer to a Particle to initialize. |
Definition at line 89 of file OgreParticleAffector.h.
| virtual void Ogre::ParticleAffector::_affectParticles | ( | ParticleSystem * | pSystem, | |
| Real | timeElapsed | |||
| ) | [pure virtual] |
Method called to allow the affector to 'do it's stuff' on all active particles in the system.
| pSystem | Pointer to a ParticleSystem to affect. | |
| timeElapsed | The number of seconds which have elapsed since the last call. |
| const String& Ogre::ParticleAffector::getType | ( | void | ) | const |
Returns the name of the type of affector.
Definition at line 108 of file OgreParticleAffector.h.
| bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
| className | the name of the class using the dictionary |
Definition at line 176 of file OgreStringInterface.h.
| ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
| const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
| const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
| virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
| const String & | value | |||
| ) | [virtual, inherited] |
Generic parameter setting method.
| name | The name of the parameter to set | |
| value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
| virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
| paramList | Name/value pair list |
| virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
| name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
| virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
Method for copying this object's parameters to another object.
| dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
| static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
String Ogre::ParticleAffector::mType [protected] |
Name of the type of affector, MUST be initialised by subclasses.
Definition at line 62 of file OgreParticleAffector.h.
ParticleSystem* Ogre::ParticleAffector::mParent [protected] |
Definition at line 74 of file OgreParticleAffector.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:51:17 2008