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:

Inheritance graph
[legend]
Collaboration diagram for Ogre::ColourFaderAffector:

Collaboration graph
[legend]
List of all members.

Public Methods

 ColourFaderAffector ()
 Default constructor.

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

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

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

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

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

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

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

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

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

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

virtual void _initParticle (Particle *pParticle)
 Method called to allow the affector to initialize all newly created particles in the system.

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

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

const ParamDictionarygetParamDictionary (void) const
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.

virtual bool setParameter (const String &name, const String &value)
 Generic parameter setting method.

virtual String getParameter (const String &name) const
 Generic parameter retrieval method.

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


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].

void addBaseParameters (void)
 Internal method for setting up the basic parameter definitions for a subclass.

bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.


Protected Attributes

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

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


Static Protected Attributes

ParamDictionaryMap msDictionary
 Dictionary of parameters.


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.

Definition at line 40 of file OgreColourFaderAffector.h.


Constructor & Destructor Documentation

Ogre::ColourFaderAffector::ColourFaderAffector  
 

Default constructor.

Definition at line 40 of file OgreColourFaderAffector.cpp.

References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::createParamDictionary(), Ogre::StringInterface::getParamDictionary(), mAlphaAdj, mBlueAdj, mGreenAdj, mRedAdj, msAlphaCmd, msBlueCmd, msGreenCmd, msRedCmd, Ogre::ParticleAffector::mType, and Ogre::PT_REAL.


Member Function Documentation

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

See ParticleAffector.

Implements Ogre::ParticleAffector.

Definition at line 67 of file OgreColourFaderAffector.cpp.

References Ogre::ParticleSystem::_getIterator(), Ogre::ColourValue::a, applyAdjustWithClamp(), Ogre::ColourValue::b, Ogre::ParticleIterator::end(), Ogre::ColourValue::g, Ogre::ParticleIterator::getNext(), mAlphaAdj, mBlueAdj, Ogre::Billboard::mColour, mGreenAdj, mRedAdj, Ogre::ColourValue::r, and Ogre::Real.

virtual void Ogre::ParticleAffector::_initParticle Particle   pParticle [virtual, inherited]
 

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:
pParticle  Pointer to a Particle to initialize.

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

Definition at line 81 of file OgreParticleAffector.h.

void Ogre::ParticleAffector::addBaseParameters void    [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.

Definition at line 68 of file OgreParticleAffector.h.

Referenced by Ogre::LinearForceAffector::LinearForceAffector().

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

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

Definition at line 142 of file OgreColourFaderAffector.h.

References Ogre::Real.

Referenced by _affectParticles().

virtual void Ogre::StringInterface::copyParametersTo StringInterface   dest const [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.

Definition at line 293 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

Referenced by Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and Ogre::ParticleSystem::operator=().

bool Ogre::StringInterface::createParamDictionary const String   className [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

Definition at line 169 of file OgreStringInterface.h.

Referenced by Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::CgProgram::CgProgram(), ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::ListGuiElement::ListGuiElement(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PointEmitter::PointEmitter(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), Ogre::ScrollBarGuiElement::ScrollBarGuiElement(), Ogre::TextAreaGuiElement::TextAreaGuiElement(), Ogre::TextBoxGuiElement::TextBoxGuiElement(), and Ogre::TTYGuiElement::TTYGuiElement().

Real Ogre::ColourFaderAffector::getAlphaAdjust void    const
 

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

Definition at line 133 of file OgreColourFaderAffector.cpp.

References mAlphaAdj, and Ogre::Real.

Referenced by Ogre::ColourFaderAffector::CmdAlphaAdjust::doGet().

Real Ogre::ColourFaderAffector::getBlueAdjust void    const
 

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

Definition at line 123 of file OgreColourFaderAffector.cpp.

References mBlueAdj, and Ogre::Real.

Referenced by Ogre::ColourFaderAffector::CmdBlueAdjust::doGet().

Real Ogre::ColourFaderAffector::getGreenAdjust void    const
 

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

Definition at line 113 of file OgreColourFaderAffector.cpp.

References mGreenAdj, and Ogre::Real.

Referenced by Ogre::ColourFaderAffector::CmdGreenAdjust::doGet().

const ParamDictionary* Ogre::StringInterface::getParamDictionary void    const [inherited]
 

Definition at line 206 of file OgreStringInterface.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary void    [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.

Definition at line 193 of file OgreStringInterface.h.

Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), Ogre::CgProgram::CgProgram(), ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter().

virtual String Ogre::StringInterface::getParameter const String   name const [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

Definition at line 262 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

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.

Definition at line 224 of file OgreStringInterface.h.

References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList.

Real Ogre::ColourFaderAffector::getRedAdjust void    const
 

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

Definition at line 103 of file OgreColourFaderAffector.cpp.

References mRedAdj, and Ogre::Real.

Referenced by Ogre::ColourFaderAffector::CmdRedAdjust::doGet().

String Ogre::ParticleAffector::getType void    const [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.

Definition at line 100 of file OgreParticleAffector.h.

Referenced by Ogre::ParticleSystemManager::_destroyAffector(), Ogre::ParticleSystem::operator=(), and Ogre::ParticleSystemManager::parseAffectorAttrib().

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.

Definition at line 90 of file OgreColourFaderAffector.cpp.

References Ogre::green, mAlphaAdj, mBlueAdj, mGreenAdj, mRedAdj, Ogre::Real, and Ogre::red.

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.

Definition at line 128 of file OgreColourFaderAffector.cpp.

References mAlphaAdj, and Ogre::Real.

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.

Definition at line 118 of file OgreColourFaderAffector.cpp.

References mBlueAdj, and Ogre::Real.

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.

Definition at line 108 of file OgreColourFaderAffector.cpp.

References Ogre::green, mGreenAdj, and Ogre::Real.

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)

Definition at line 33 of file OgreStringInterface.cpp.

References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), and Ogre::StringInterface::getParamDictionary().

Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib().

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.

Definition at line 98 of file OgreColourFaderAffector.cpp.

References mRedAdj, Ogre::Real, and Ogre::red.


Member Data Documentation

Real Ogre::ColourFaderAffector::mAlphaAdj [protected]
 

Definition at line 139 of file OgreColourFaderAffector.h.

Referenced by _affectParticles(), ColourFaderAffector(), getAlphaAdjust(), setAdjust(), and setAlphaAdjust().

Real Ogre::ColourFaderAffector::mBlueAdj [protected]
 

Definition at line 138 of file OgreColourFaderAffector.h.

Referenced by _affectParticles(), ColourFaderAffector(), getBlueAdjust(), setAdjust(), and setBlueAdjust().

Real Ogre::ColourFaderAffector::mGreenAdj [protected]
 

Definition at line 137 of file OgreColourFaderAffector.h.

Referenced by _affectParticles(), ColourFaderAffector(), getGreenAdjust(), setAdjust(), and setGreenAdjust().

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

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

Definition at line 157 of file OgreStringInterface.h.

Real Ogre::ColourFaderAffector::mRedAdj [protected]
 

Definition at line 136 of file OgreColourFaderAffector.h.

Referenced by _affectParticles(), ColourFaderAffector(), getRedAdjust(), setAdjust(), and setRedAdjust().

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

Definition at line 37 of file OgreColourFaderAffector.cpp.

Referenced by ColourFaderAffector().

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

Definition at line 36 of file OgreColourFaderAffector.cpp.

Referenced by ColourFaderAffector().

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

Dictionary of parameters.

Definition at line 30 of file OgreStringInterface.cpp.

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

Definition at line 35 of file OgreColourFaderAffector.cpp.

Referenced by ColourFaderAffector().

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

Definition at line 34 of file OgreColourFaderAffector.cpp.

Referenced by ColourFaderAffector().

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

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

Definition at line 58 of file OgreParticleAffector.h.

Referenced by ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RotationAffector::RotationAffector(), and Ogre::ScaleAffector::ScaleAffector().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:12:58 2004