OGRE-Next  3.0.0
Object-Oriented Graphics Rendering Engine
Ogre::ColourFaderAffector2 Class Reference

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

#include <OgreColourFaderAffector2.h>

+ Inheritance diagram for Ogre::ColourFaderAffector2:

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) override
 See ParticleAffector. More...
 
float getAlphaAdjust1 () const
 Gets the alpha adjustment to be made per second to particles. More...
 
float getAlphaAdjust2 () const
 
float getBlueAdjust1 () const
 Gets the blue adjustment to be made per second to particles. More...
 
float getBlueAdjust2 () const
 
float getGreenAdjust1 () const
 Gets the green adjustment to be made per second to particles. More...
 
float getGreenAdjust2 () const
 
float getRedAdjust1 () const
 Gets the red adjustment to be made per second to particles. More...
 
float getRedAdjust2 () const
 
Real getStateChange () const
 
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)
 
void setRedAdjust1 (float red)
 Sets the red adjustment to be made per second to particles. More...
 
void setRedAdjust2 (float red)
 
void setStateChange (Real NewValue)
 
- 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 () 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...
 
virtual void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary ()
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary () const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters () const
 Retrieves a list of parameters valid for this object. More...
 
virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
virtual void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. 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
 

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

◆ ColourFaderAffector2()

Ogre::ColourFaderAffector2::ColourFaderAffector2 ( ParticleSystem psys)

Default constructor.

Member Function Documentation

◆ _affectParticles()

void Ogre::ColourFaderAffector2::_affectParticles ( ParticleSystem pSystem,
Real  timeElapsed 
)
overridevirtual

◆ getAlphaAdjust1()

float Ogre::ColourFaderAffector2::getAlphaAdjust1 ( ) const

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

◆ getAlphaAdjust2()

float Ogre::ColourFaderAffector2::getAlphaAdjust2 ( ) const

◆ getBlueAdjust1()

float Ogre::ColourFaderAffector2::getBlueAdjust1 ( ) const

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

◆ getBlueAdjust2()

float Ogre::ColourFaderAffector2::getBlueAdjust2 ( ) const

◆ getGreenAdjust1()

float Ogre::ColourFaderAffector2::getGreenAdjust1 ( ) const

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

◆ getGreenAdjust2()

float Ogre::ColourFaderAffector2::getGreenAdjust2 ( ) const

◆ getRedAdjust1()

float Ogre::ColourFaderAffector2::getRedAdjust1 ( ) const

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

◆ getRedAdjust2()

float Ogre::ColourFaderAffector2::getRedAdjust2 ( ) const

◆ getStateChange()

Real Ogre::ColourFaderAffector2::getStateChange ( ) const

◆ setAdjust1()

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.

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.

◆ setAdjust2()

void Ogre::ColourFaderAffector2::setAdjust2 ( float  red,
float  green,
float  blue,
float  alpha = 0.0 
)

◆ setAlphaAdjust1()

void Ogre::ColourFaderAffector2::setAlphaAdjust1 ( 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.

◆ setAlphaAdjust2()

void Ogre::ColourFaderAffector2::setAlphaAdjust2 ( float  alpha)

◆ setBlueAdjust1()

void Ogre::ColourFaderAffector2::setBlueAdjust1 ( 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.

◆ setBlueAdjust2()

void Ogre::ColourFaderAffector2::setBlueAdjust2 ( float  blue)

◆ setGreenAdjust1()

void Ogre::ColourFaderAffector2::setGreenAdjust1 ( 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.

◆ setGreenAdjust2()

void Ogre::ColourFaderAffector2::setGreenAdjust2 ( float  green)

◆ setRedAdjust1()

void Ogre::ColourFaderAffector2::setRedAdjust1 ( 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.

◆ setRedAdjust2()

void Ogre::ColourFaderAffector2::setRedAdjust2 ( float  red)

◆ setStateChange()

void Ogre::ColourFaderAffector2::setStateChange ( Real  NewValue)

Member Data Documentation

◆ msAlphaCmd1

CmdAlphaAdjust1 Ogre::ColourFaderAffector2::msAlphaCmd1
static

◆ msAlphaCmd2

CmdAlphaAdjust2 Ogre::ColourFaderAffector2::msAlphaCmd2
static

◆ msBlueCmd1

CmdBlueAdjust1 Ogre::ColourFaderAffector2::msBlueCmd1
static

◆ msBlueCmd2

CmdBlueAdjust2 Ogre::ColourFaderAffector2::msBlueCmd2
static

◆ msGreenCmd1

CmdGreenAdjust1 Ogre::ColourFaderAffector2::msGreenCmd1
static

◆ msGreenCmd2

CmdGreenAdjust2 Ogre::ColourFaderAffector2::msGreenCmd2
static

◆ msRedCmd1

CmdRedAdjust1 Ogre::ColourFaderAffector2::msRedCmd1
static

◆ msRedCmd2

CmdRedAdjust2 Ogre::ColourFaderAffector2::msRedCmd2
static

◆ msStateCmd

CmdStateChange Ogre::ColourFaderAffector2::msStateCmd
static

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