OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::ColourFaderAffector Class Reference

This plugin subclass of ParticleAffector allows you to alter the colour of particles. More...

#include <OgreColourFaderAffector.h>

+ Inheritance diagram for Ogre::ColourFaderAffector:

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...
 
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...
 
float getRedAdjust (void) const
 Gets the red adjustment to be made per second to particles. More...
 
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...
 
void setRedAdjust (float red)
 Sets the red adjustment to be made per second to particles. More...
 
- Public Member Functions inherited from Ogre::ParticleAffector
 ParticleAffector (ParticleSystem *parent)
 
virtual ~ParticleAffector ()
 Virtual destructor essential. More...
 
virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system. More...
 
const StringgetType (void) const
 Returns the name of the type of affector. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 

Static Public Attributes

static CmdAlphaAdjust msAlphaCmd
 
static CmdBlueAdjust msBlueCmd
 
static CmdGreenAdjust msGreenCmd
 
static CmdRedAdjust msRedCmd
 

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::StringInterface
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...
 

Detailed Description

This plugin subclass of ParticleAffector allows you to alter the colour of particles.

Remarks
This class supplies the ParticleAffector implementation required to modify the colour of particle in mid-flight.

Constructor & Destructor Documentation

◆ ColourFaderAffector()

Ogre::ColourFaderAffector::ColourFaderAffector ( ParticleSystem psys)

Default constructor.

Member Function Documentation

◆ _affectParticles()

void Ogre::ColourFaderAffector::_affectParticles ( ParticleSystem pSystem,
Real  timeElapsed 
)
virtual

◆ setAdjust()

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.

Parameters
red,green,blue,alphaSets 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.

◆ setRedAdjust()

void Ogre::ColourFaderAffector::setRedAdjust ( float  red)

Sets the red adjustment to be made per second to particles.

Parameters
redThe 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.

◆ getRedAdjust()

float Ogre::ColourFaderAffector::getRedAdjust ( void  ) const

Gets the red adjustment to be made per second to particles.

◆ setGreenAdjust()

void Ogre::ColourFaderAffector::setGreenAdjust ( float  green)

Sets the green adjustment to be made per second to particles.

Parameters
greenThe 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.

◆ getGreenAdjust()

float Ogre::ColourFaderAffector::getGreenAdjust ( void  ) const

Gets the green adjustment to be made per second to particles.

◆ setBlueAdjust()

void Ogre::ColourFaderAffector::setBlueAdjust ( float  blue)

Sets the blue adjustment to be made per second to particles.

Parameters
blueThe 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.

◆ getBlueAdjust()

float Ogre::ColourFaderAffector::getBlueAdjust ( void  ) const

Gets the blue adjustment to be made per second to particles.

◆ setAlphaAdjust()

void Ogre::ColourFaderAffector::setAlphaAdjust ( float  alpha)

Sets the alpha adjustment to be made per second to particles.

Parameters
alphaThe 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.

◆ getAlphaAdjust()

float Ogre::ColourFaderAffector::getAlphaAdjust ( void  ) const

Gets the alpha adjustment to be made per second to particles.

Member Data Documentation

◆ msRedCmd

CmdRedAdjust Ogre::ColourFaderAffector::msRedCmd
static

◆ msGreenCmd

CmdGreenAdjust Ogre::ColourFaderAffector::msGreenCmd
static

◆ msBlueCmd

CmdBlueAdjust Ogre::ColourFaderAffector::msBlueCmd
static

◆ msAlphaCmd

CmdAlphaAdjust Ogre::ColourFaderAffector::msAlphaCmd
static

The documentation for this class was generated from the following file: