OGRE
1.9.0
|
Abstract class defining the interface to be implemented by particle affectors. More...
#include <OgreParticleAffector.h>
Public Member Functions | |
ParticleAffector (ParticleSystem *parent) | |
virtual | ~ParticleAffector () |
Virtual destructor essential. | |
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. | |
virtual void | _initParticle (Particle *pParticle) |
Method called to allow the affector to initialize all newly created particles in the system. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
const String & | getType (void) const |
Returns the name of the type of affector. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new (size_t sz, void *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
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 | |
ParticleSystem * | mParent |
String | mType |
Name of the type of affector, MUST be initialised by subclasses. | |
Private Member Functions | |
OGRE_STATIC_MUTEX (msDictionaryMutex) | |
Private Attributes | |
ParamDictionary * | mParamDict |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses) | |
Static Private Attributes | |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Abstract class defining the interface to be implemented by particle affectors.
Definition at line 64 of file OgreParticleAffector.h.
Ogre::ParticleAffector::ParticleAffector | ( | ParticleSystem * | parent | ) |
Definition at line 82 of file OgreParticleAffector.h.
References mParent.
|
virtual |
Virtual destructor essential.
|
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. |
|
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 95 of file OgreParticleAffector.h.
|
protected |
Internal method for setting up the basic parameter definitions for a subclass.
Definition at line 78 of file OgreParticleAffector.h.
|
staticinherited |
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.
|
virtualinherited |
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 303 of file OgreStringInterface.h.
References StringInterface(), getParamDictionary(), getParameter(), Ogre::ParamDictionary::mParamDefs, and setParameter().
|
protectedinherited |
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 186 of file OgreStringInterface.h.
References mParamDict, mParamDictName, msDictionary, and OGRE_LOCK_MUTEX.
|
inherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
References mParamDict.
Referenced by copyParametersTo(), and getParameter().
|
inherited |
Definition at line 224 of file OgreStringInterface.h.
References mParamDict.
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), Ogre::ParamDictionary::getParamCommand(), and getParamDictionary().
Referenced by copyParametersTo().
|
inherited |
Retrieves a list of parameters valid for this object.
const String & Ogre::ParticleAffector::getType | ( | void | ) | const |
Returns the name of the type of affector.
Definition at line 118 of file OgreParticleAffector.h.
References mType.
|
privateinherited |
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
virtualinherited |
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 copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
privateinherited |
Definition at line 173 of file OgreStringInterface.h.
Referenced by StringInterface(), createParamDictionary(), getParamDictionary(), and getParamDictionary().
|
privateinherited |
Class name for this instance to be used as a lookup (must be initialised by subclasses)
Definition at line 172 of file OgreStringInterface.h.
Referenced by createParamDictionary().
|
protected |
Definition at line 80 of file OgreParticleAffector.h.
Referenced by ParticleAffector().
|
staticprivateinherited |
Dictionary of parameters.
Definition at line 169 of file OgreStringInterface.h.
Referenced by createParamDictionary().
|
protected |
Name of the type of affector, MUST be initialised by subclasses.
Definition at line 68 of file OgreParticleAffector.h.
Referenced by getType().