Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

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:

Ogre::ParticleAffector Ogre::StringInterface List of all members.

Public Methods

 ColourFaderAffector ()
 Default constructor. More...

void _affectParticles (ParticleSystem *pSystem, Real timeElapsed)
 See ParticleAffector. More...

void setAdjust (Real red, Real green, Real blue, Real alpha=0.0)
 Sets the colour adjustment to be made per second to particles. More...

void setRedAdjust (Real red)
 Sets the red adjustment to be made per second to particles. More...

Real getRedAdjust (void)
 Gets the red adjustment to be made per second to particles. More...

void setGreenAdjust (Real green)
 Sets the green adjustment to be made per second to particles. More...

Real getGreenAdjust (void)
 Gets the green adjustment to be made per second to particles. More...

void setBlueAdjust (Real blue)
 Sets the blue adjustment to be made per second to particles. More...

Real getBlueAdjust (void)
 Gets the blue adjustment to be made per second to particles. More...

void setAlphaAdjust (Real alpha)
 Sets the alpha adjustment to be made per second to particles. More...

Real getAlphaAdjust (void)
 Gets the alpha adjustment to be made per second to particles. More...

String getType (void)
 Returns the name of the type of affector. More...

ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...

const ParameterListgetParameters (void)
 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 String getParameter (const String &name)
 Generic parameter retrieval method. More...

virtual void copyParametersTo (StringInterface *dest)
 Method for copying this object's parameters to another object. More...


Static Public Attributes

CmdRedAdjust msRedCmd
CmdGreenAdjust msGreenCmd
CmdBlueAdjust msBlueCmd
CmdAlphaAdjust msAlphaCmd

Protected Methods

void applyAdjustWithClamp (Real *pComponent, Real adjust)
 Internal method for adjusting while clamping to [0,1]. More...

void addBaseParameters (void)
 Internal method for setting up the basic parameter definitions for a subclass. 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

Real mRedAdj
Real mGreenAdj
Real mBlueAdj
Real mAlphaAdj
String mType
 Name of the type of affector, MUST be initialised by subclasses. More...

String mParamDictName
 Class name for this instance to be used as a lookup (must be initialised by subclasses). More...


Static Protected Attributes

ParamDictionaryMap msDictionary
 Dictionary of parameters. 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

Ogre::ColourFaderAffector::ColourFaderAffector  
 

Default constructor.


Member Function Documentation

void Ogre::ColourFaderAffector::_affectParticles ParticleSystem   pSystem,
Real    timeElapsed
[virtual]
 

See ParticleAffector.

Implements Ogre::ParticleAffector.

void Ogre::ParticleAffector::addBaseParameters void    [inline, protected, inherited]
 

Internal method for setting up the basic parameter definitions for a subclass.

Remarks:
Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context.

The subclass must have called it's own createParamDictionary before calling this method.

void Ogre::ColourFaderAffector::applyAdjustWithClamp Real   pComponent,
Real    adjust
[inline, protected]
 

Internal method for adjusting while clamping to [0,1].

virtual void Ogre::StringInterface::copyParametersTo StringInterface   dest [inline, virtual, inherited]
 

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:
dest  Pointer to object to have it's parameters set the same as this object.

bool Ogre::StringInterface::createParamDictionary const String   className [inline, protected, inherited]
 

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters:
className  the name of the class using the dictionary
Returns:
true if a new dictionary was created, false if it was already there

Real Ogre::ColourFaderAffector::getAlphaAdjust void   
 

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

Real Ogre::ColourFaderAffector::getBlueAdjust void   
 

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

Real Ogre::ColourFaderAffector::getGreenAdjust void   
 

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

ParamDictionary* Ogre::StringInterface::getParamDictionary void    [inline, inherited]
 

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.

virtual String Ogre::StringInterface::getParameter const String   name [inline, virtual, inherited]
 

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:
name  The name of the parameter to get
Returns:
String value of parameter, blank if not found

const ParameterList& Ogre::StringInterface::getParameters void    [inline, inherited]
 

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.

Real Ogre::ColourFaderAffector::getRedAdjust void   
 

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

String Ogre::ParticleAffector::getType void    [inline, inherited]
 

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.

void Ogre::ColourFaderAffector::setAdjust Real    red,
Real    green,
Real    blue,
Real    alpha = 0.0
 

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

Parameters:
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 Real    alpha
 

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

Parameters:
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 Real    blue
 

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

Parameters:
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 Real    green
 

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

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

bool Ogre::StringInterface::setParameter const String   name,
const String   value
[virtual, 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:
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.
Returns:
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

void Ogre::ColourFaderAffector::setRedAdjust Real    red
 

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

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


Member Data Documentation

Real Ogre::ColourFaderAffector::mAlphaAdj [protected]
 

Real Ogre::ColourFaderAffector::mBlueAdj [protected]
 

Real Ogre::ColourFaderAffector::mGreenAdj [protected]
 

String Ogre::StringInterface::mParamDictName [protected, inherited]
 

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Real Ogre::ColourFaderAffector::mRedAdj [protected]
 

ColourFaderAffector::CmdAlphaAdjust Ogre::ColourFaderAffector::msAlphaCmd [static]
 

ColourFaderAffector::CmdBlueAdjust Ogre::ColourFaderAffector::msBlueCmd [static]
 

ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited]
 

Dictionary of parameters.

ColourFaderAffector::CmdGreenAdjust Ogre::ColourFaderAffector::msGreenCmd [static]
 

ColourFaderAffector::CmdRedAdjust Ogre::ColourFaderAffector::msRedCmd [static]
 

String Ogre::ParticleAffector::mType [protected, inherited]
 

Name of the type of affector, MUST be initialised by subclasses.

Copyright © 2002 by The OGRE Team