This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...
#include <OgreColourFaderAffector.h>
Classes | |
class | CmdAlphaAdjust |
Command object for alpha adjust (see ParamCommand). More... | |
class | CmdBlueAdjust |
Command object for blue adjust (see ParamCommand). More... | |
class | CmdGreenAdjust |
Command object for green adjust (see ParamCommand). More... | |
class | CmdRedAdjust |
Command object for red adjust (see ParamCommand). More... | |
Public Member Functions | |
ColourFaderAffector (ParticleSystem *psys) | |
Default constructor. More... | |
void | _affectParticles (ParticleSystem *pSystem, Real timeElapsed) |
See ParticleAffector. More... | |
virtual void | _initParticle (Particle *pParticle) |
Method called to allow the affector to initialize all newly created particles in the system. More... | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
float | getAlphaAdjust (void) const |
Gets the alpha adjustment to be made per second to particles. More... | |
float | getBlueAdjust (void) const |
Gets the blue adjustment to be made per second to particles. More... | |
float | getGreenAdjust (void) const |
Gets the green adjustment to be made per second to particles. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
float | getRedAdjust (void) const |
Gets the red adjustment to be made per second to particles. More... | |
const String & | getType (void) const |
Returns the name of the type of affector. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | setAdjust (float red, float green, float blue, float alpha=0.0) |
Sets the colour adjustment to be made per second to particles. More... | |
void | setAlphaAdjust (float alpha) |
Sets the alpha adjustment to be made per second to particles. More... | |
void | setBlueAdjust (float blue) |
Sets the blue adjustment to be made per second to particles. More... | |
void | setGreenAdjust (float green) |
Sets the green adjustment to be made per second to particles. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setRedAdjust (float red) |
Sets the red adjustment to be made per second to particles. More... | |
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. More... | |
Static Public Attributes | |
static CmdAlphaAdjust | msAlphaCmd |
static CmdBlueAdjust | msBlueCmd |
static CmdGreenAdjust | msGreenCmd |
static CmdRedAdjust | msRedCmd |
Protected Member Functions | |
void | addBaseParameters (void) |
Internal method for setting up the basic parameter definitions for a subclass. More... | |
void | applyAdjustWithClamp (float *pComponent, float adjust) |
Internal method for adjusting while clamping to [0,1]. 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 | |
float | mAlphaAdj |
float | mBlueAdj |
float | mGreenAdj |
ParticleSystem * | mParent |
float | mRedAdj |
String | mType |
Name of the type of affector, MUST be initialised by subclasses. More... | |
This plugin subclass of ParticleAffector allows you to alter the colour of particles.
Definition at line 43 of file OgreColourFaderAffector.h.
Ogre::ColourFaderAffector::ColourFaderAffector | ( | ParticleSystem * | psys | ) |
Default constructor.
|
virtual |
See ParticleAffector.
Implements Ogre::ParticleAffector.
|
inlinevirtualinherited |
Method called to allow the affector to initialize all newly created particles in the system.
pParticle | Pointer to a Particle to initialize. |
Reimplemented in Ogre::RotationAffector, and Ogre::ColourImageAffector.
Definition at line 95 of file OgreParticleAffector.h.
|
inlineprotectedinherited |
Internal method for setting up the basic parameter definitions for a subclass.
Definition at line 78 of file OgreParticleAffector.h.
|
inlineprotected |
Internal method for adjusting while clamping to [0,1].
Definition at line 145 of file OgreColourFaderAffector.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.
|
inlinevirtualinherited |
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 302 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
inlineprotectedinherited |
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 185 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
float Ogre::ColourFaderAffector::getAlphaAdjust | ( | void | ) | const |
Gets the alpha adjustment to be made per second to particles.
float Ogre::ColourFaderAffector::getBlueAdjust | ( | void | ) | const |
Gets the blue adjustment to be made per second to particles.
float Ogre::ColourFaderAffector::getGreenAdjust | ( | void | ) | const |
Gets the green adjustment to be made per second to particles.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 218 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 223 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 271 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
float Ogre::ColourFaderAffector::getRedAdjust | ( | void | ) | const |
Gets the red adjustment to be made per second to particles.
|
inlineinherited |
Returns the name of the type of affector.
Definition at line 118 of file OgreParticleAffector.h.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
void Ogre::ColourFaderAffector::setAdjust | ( | float | red, |
float | green, | ||
float | blue, | ||
float | alpha = 0.0 |
||
) |
Sets the colour adjustment to be made per second to particles.
red,green,blue,alpha | Sets the adjustment to be made to each of the colour components per second. These values will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. |
void Ogre::ColourFaderAffector::setAlphaAdjust | ( | float | alpha | ) |
Sets the alpha adjustment to be made per second to particles.
alpha | The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. |
void Ogre::ColourFaderAffector::setBlueAdjust | ( | float | blue | ) |
Sets the blue adjustment to be made per second to particles.
blue | The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. |
void Ogre::ColourFaderAffector::setGreenAdjust | ( | float | green | ) |
Sets the green adjustment to be made per second to particles.
green | The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. |
|
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 Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
void Ogre::ColourFaderAffector::setRedAdjust | ( | float | red | ) |
Sets the red adjustment to be made per second to particles.
red | The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. |
|
protected |
Definition at line 142 of file OgreColourFaderAffector.h.
|
protected |
Definition at line 141 of file OgreColourFaderAffector.h.
|
protected |
Definition at line 140 of file OgreColourFaderAffector.h.
|
protectedinherited |
Definition at line 80 of file OgreParticleAffector.h.
|
protected |
Definition at line 139 of file OgreColourFaderAffector.h.
|
static |
Definition at line 136 of file OgreColourFaderAffector.h.
|
static |
Definition at line 135 of file OgreColourFaderAffector.h.
|
static |
Definition at line 134 of file OgreColourFaderAffector.h.
|
static |
Definition at line 133 of file OgreColourFaderAffector.h.
|
protectedinherited |
Name of the type of affector, MUST be initialised by subclasses.
Definition at line 68 of file OgreParticleAffector.h.