OGRE  1.10.12
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)
 See ParticleAffector. More...
 
virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system. More...
 
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
 
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...
 
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 StringgetType (void) const
 Returns the name of the type of affector. More...
 
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)
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 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
 

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 
)
virtual

◆ 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 
)

◆ 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)

◆ getRedAdjust1()

float Ogre::ColourFaderAffector2::getRedAdjust1 ( void  ) const

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

◆ getRedAdjust2()

float Ogre::ColourFaderAffector2::getRedAdjust2 ( void  ) const

◆ 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)

◆ getGreenAdjust1()

float Ogre::ColourFaderAffector2::getGreenAdjust1 ( void  ) const

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

◆ getGreenAdjust2()

float Ogre::ColourFaderAffector2::getGreenAdjust2 ( void  ) const

◆ 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)

◆ getBlueAdjust1()

float Ogre::ColourFaderAffector2::getBlueAdjust1 ( void  ) const

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

◆ getBlueAdjust2()

float Ogre::ColourFaderAffector2::getBlueAdjust2 ( void  ) const

◆ 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)

◆ getAlphaAdjust1()

float Ogre::ColourFaderAffector2::getAlphaAdjust1 ( void  ) const

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

◆ getAlphaAdjust2()

float Ogre::ColourFaderAffector2::getAlphaAdjust2 ( void  ) const

◆ setStateChange()

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

◆ getStateChange()

Real Ogre::ColourFaderAffector2::getStateChange ( void  ) const

◆ _initParticle()

virtual void Ogre::ParticleAffector::_initParticle ( Particle pParticle)
inlinevirtualinherited

Method called to allow the affector to initialize all newly created particles in the system.

Remarks
This is where the affector gets the chance to initialize it's effects to the particles of a system. The affector is expected to initialize some or all of the particles in the system passed to it, depending on the affector's approach.
Parameters
pParticlePointer to a Particle to initialize.

Reimplemented in Ogre::RotationAffector, and Ogre::ColourImageAffector.

◆ getType()

const String& Ogre::ParticleAffector::getType ( void  ) const
inlineinherited

Returns the name of the type of affector.

Remarks
This property is useful for determining the type of affector procedurally so another can be created.

◆ getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

◆ getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

◆ getParameters()

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.

◆ setParameter()

bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
inherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

◆ setParameterList()

void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
inherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list

◆ getParameter()

String Ogre::StringInterface::getParameter ( const String name) const
inlineinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

References Ogre::ParamCommand::doGet().

◆ copyParametersTo()

void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlineinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

References Ogre::StringInterface::setParameter().

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )
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.

Member Data Documentation

◆ msRedCmd1

CmdRedAdjust1 Ogre::ColourFaderAffector2::msRedCmd1
static

◆ msRedCmd2

CmdRedAdjust2 Ogre::ColourFaderAffector2::msRedCmd2
static

◆ msGreenCmd1

CmdGreenAdjust1 Ogre::ColourFaderAffector2::msGreenCmd1
static

◆ msGreenCmd2

CmdGreenAdjust2 Ogre::ColourFaderAffector2::msGreenCmd2
static

◆ msBlueCmd1

CmdBlueAdjust1 Ogre::ColourFaderAffector2::msBlueCmd1
static

◆ msBlueCmd2

CmdBlueAdjust2 Ogre::ColourFaderAffector2::msBlueCmd2
static

◆ msAlphaCmd1

CmdAlphaAdjust1 Ogre::ColourFaderAffector2::msAlphaCmd1
static

◆ msAlphaCmd2

CmdAlphaAdjust2 Ogre::ColourFaderAffector2::msAlphaCmd2
static

◆ msStateCmd

CmdStateChange Ogre::ColourFaderAffector2::msStateCmd
static

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