This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...
#include <OgreColourFaderAffector2.h>
Classes | |
class | CmdAlphaAdjust1 |
Command object for alpha adjust (see ParamCommand). More... | |
class | CmdAlphaAdjust2 |
Command object for alpha adjust (see ParamCommand). More... | |
class | CmdBlueAdjust1 |
Command object for blue adjust (see ParamCommand). More... | |
class | CmdBlueAdjust2 |
Command object for blue adjust (see ParamCommand). More... | |
class | CmdGreenAdjust1 |
Command object for green adjust (see ParamCommand). More... | |
class | CmdGreenAdjust2 |
Command object for green adjust (see ParamCommand). More... | |
class | CmdRedAdjust1 |
Command object for red adjust (see ParamCommand). More... | |
class | CmdRedAdjust2 |
Command object for red adjust (see ParamCommand). More... | |
class | CmdStateChange |
Command object for alpha adjust (see ParamCommand). More... | |
Public Member Functions | |
ColourFaderAffector2 (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 | getAlphaAdjust1 (void) const |
Gets the alpha adjustment to be made per second to particles. More... | |
float | getAlphaAdjust2 (void) const |
float | getBlueAdjust1 (void) const |
Gets the blue adjustment to be made per second to particles. More... | |
float | getBlueAdjust2 (void) const |
float | getGreenAdjust1 (void) const |
Gets the green adjustment to be made per second to particles. More... | |
float | getGreenAdjust2 (void) const |
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 | getRedAdjust1 (void) const |
Gets the red adjustment to be made per second to particles. More... | |
float | getRedAdjust2 (void) const |
Real | getStateChange (void) const |
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 | setAdjust1 (float red, float green, float blue, float alpha=0.0) |
Sets the colour adjustment to be made per second to particles. More... | |
void | setAdjust2 (float red, float green, float blue, float alpha=0.0) |
void | setAlphaAdjust1 (float alpha) |
Sets the alpha adjustment to be made per second to particles. More... | |
void | setAlphaAdjust2 (float alpha) |
void | setBlueAdjust1 (float blue) |
Sets the blue adjustment to be made per second to particles. More... | |
void | setBlueAdjust2 (float blue) |
void | setGreenAdjust1 (float green) |
Sets the green adjustment to be made per second to particles. More... | |
void | setGreenAdjust2 (float green) |
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 | setRedAdjust1 (float red) |
Sets the red adjustment to be made per second to particles. More... | |
void | setRedAdjust2 (float red) |
void | setStateChange (Real NewValue) |
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 CmdAlphaAdjust1 | msAlphaCmd1 |
static CmdAlphaAdjust2 | msAlphaCmd2 |
static CmdBlueAdjust1 | msBlueCmd1 |
static CmdBlueAdjust2 | msBlueCmd2 |
static CmdGreenAdjust1 | msGreenCmd1 |
static CmdGreenAdjust2 | msGreenCmd2 |
static CmdRedAdjust1 | msRedCmd1 |
static CmdRedAdjust2 | msRedCmd2 |
static CmdStateChange | msStateCmd |
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 | mAlphaAdj1 |
float | mAlphaAdj2 |
float | mBlueAdj1 |
float | mBlueAdj2 |
float | mGreenAdj1 |
float | mGreenAdj2 |
ParticleSystem * | mParent |
float | mRedAdj1 |
float | mRedAdj2 |
String | mType |
Name of the type of affector, MUST be initialised by subclasses. More... | |
Real | StateChangeVal |
This plugin subclass of ParticleAffector allows you to alter the colour of particles.
Definition at line 43 of file OgreColourFaderAffector2.h.
Ogre::ColourFaderAffector2::ColourFaderAffector2 | ( | 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 204 of file OgreColourFaderAffector2.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 303 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 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
float Ogre::ColourFaderAffector2::getAlphaAdjust1 | ( | void | ) | const |
Gets the alpha adjustment to be made per second to particles.
float Ogre::ColourFaderAffector2::getAlphaAdjust2 | ( | void | ) | const |
float Ogre::ColourFaderAffector2::getBlueAdjust1 | ( | void | ) | const |
Gets the blue adjustment to be made per second to particles.
float Ogre::ColourFaderAffector2::getBlueAdjust2 | ( | void | ) | const |
float Ogre::ColourFaderAffector2::getGreenAdjust1 | ( | void | ) | const |
Gets the green adjustment to be made per second to particles.
float Ogre::ColourFaderAffector2::getGreenAdjust2 | ( | void | ) | const |
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
float Ogre::ColourFaderAffector2::getRedAdjust1 | ( | void | ) | const |
Gets the red adjustment to be made per second to particles.
float Ogre::ColourFaderAffector2::getRedAdjust2 | ( | void | ) | const |
Real Ogre::ColourFaderAffector2::getStateChange | ( | void | ) | const |
|
inlineinherited |
Returns the name of the type of affector.
Definition at line 118 of file OgreParticleAffector.h.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::ColourFaderAffector2::setAdjust1 | ( | 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::ColourFaderAffector2::setAdjust2 | ( | float | red, |
float | green, | ||
float | blue, | ||
float | alpha = 0.0 |
||
) |
void Ogre::ColourFaderAffector2::setAlphaAdjust1 | ( | 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::ColourFaderAffector2::setAlphaAdjust2 | ( | float | alpha | ) |
void Ogre::ColourFaderAffector2::setBlueAdjust1 | ( | 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::ColourFaderAffector2::setBlueAdjust2 | ( | float | blue | ) |
void Ogre::ColourFaderAffector2::setGreenAdjust1 | ( | 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. |
void Ogre::ColourFaderAffector2::setGreenAdjust2 | ( | float | green | ) |
|
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::ColourFaderAffector2::setRedAdjust1 | ( | 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. |
void Ogre::ColourFaderAffector2::setRedAdjust2 | ( | float | red | ) |
void Ogre::ColourFaderAffector2::setStateChange | ( | Real | NewValue | ) |
|
protected |
Definition at line 200 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 200 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 199 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 199 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 198 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 198 of file OgreColourFaderAffector2.h.
|
protectedinherited |
Definition at line 80 of file OgreParticleAffector.h.
|
protected |
Definition at line 197 of file OgreColourFaderAffector2.h.
|
protected |
Definition at line 197 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 192 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 193 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 190 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 191 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 188 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 189 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 186 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 187 of file OgreColourFaderAffector2.h.
|
static |
Definition at line 194 of file OgreColourFaderAffector2.h.
|
protectedinherited |
Name of the type of affector, MUST be initialised by subclasses.
Definition at line 68 of file OgreParticleAffector.h.
|
protected |
Definition at line 201 of file OgreColourFaderAffector2.h.