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:

Collaboration 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...
virtual void	_initParticle (Particle *pParticle)
	Method called to allow the affector to initialize all newly created particles in the system. More...
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. 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...
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary (void) const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...
float	getRedAdjust (void) const
	Gets the red adjustment to be made per second to particles. More...
const String &	getType (void) const
	Returns the name of the type of affector. More...
void	operator delete (void *ptr)
void	operator delete (void *ptr, void *)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void *	operator new[] (size_t sz)
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...
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...
void	setRedAdjust (float red)
	Sets the red adjustment to be made per second to particles. More...

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 CmdAlphaAdjust	msAlphaCmd
static CmdBlueAdjust	msBlueCmd
static CmdGreenAdjust	msGreenCmd
static CmdRedAdjust	msRedCmd

Protected Member Functions
void	addBaseParameters (void)
	Internal method for setting up the basic parameter definitions for a subclass. More...
void	applyAdjustWithClamp (float *pComponent, float adjust)
	Internal method for adjusting while clamping to [0,1]. 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
float	mAlphaAdj
float	mBlueAdj
float	mGreenAdj
ParticleSystem *	mParent
float	mRedAdj
String	mType
	Name of the type of affector, MUST be initialised by subclasses. 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.

Definition at line 43 of file OgreColourFaderAffector.h.

Constructor & Destructor Documentation

Ogre::ColourFaderAffector::ColourFaderAffector

(

ParticleSystem *

psys

)

Default constructor.

Member Function Documentation

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

virtual

See ParticleAffector.

Implements Ogre::ParticleAffector.

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

pParticle

Pointer to a Particle to initialize.

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

Definition at line 94 of file OgreParticleAffector.h.

void Ogre::ParticleAffector::addBaseParameters ( void  )

inlineprotectedinherited

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 77 of file OgreParticleAffector.h.

void Ogre::ColourFaderAffector::applyAdjustWithClamp ( float *  pComponent, float  adjust  )

inlineprotected

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

Definition at line 145 of file OgreColourFaderAffector.h.

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.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface *  dest ) const

inlinevirtualinherited

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 301 of file OgreStringInterface.h.

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

bool Ogre::StringInterface::createParamDictionary ( const String &  className )

inlineprotectedinherited

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 184 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

float Ogre::ColourFaderAffector::getAlphaAdjust

(

void

)

const

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

float Ogre::ColourFaderAffector::getBlueAdjust

(

void

)

const

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

float Ogre::ColourFaderAffector::getGreenAdjust

(

void

)

const

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

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.

Definition at line 217 of file OgreStringInterface.h.

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

inlineinherited

Definition at line 222 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String &  name ) const

inlinevirtualinherited

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

float Ogre::ColourFaderAffector::getRedAdjust

(

void

)

const

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

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.

Definition at line 117 of file OgreParticleAffector.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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,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

(

float

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

(

float

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

(

float

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.

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

virtualinherited

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)

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

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList &  paramList )

virtualinherited

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

paramList

Name/value pair list

void Ogre::ColourFaderAffector::setRedAdjust

(

float

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

float Ogre::ColourFaderAffector::mAlphaAdj

protected

Definition at line 142 of file OgreColourFaderAffector.h.

float Ogre::ColourFaderAffector::mBlueAdj

protected

Definition at line 141 of file OgreColourFaderAffector.h.

float Ogre::ColourFaderAffector::mGreenAdj

protected

Definition at line 140 of file OgreColourFaderAffector.h.

ParticleSystem* Ogre::ParticleAffector::mParent

protectedinherited

Definition at line 79 of file OgreParticleAffector.h.

float Ogre::ColourFaderAffector::mRedAdj

protected

Definition at line 139 of file OgreColourFaderAffector.h.

CmdAlphaAdjust Ogre::ColourFaderAffector::msAlphaCmd

static

Definition at line 136 of file OgreColourFaderAffector.h.

CmdBlueAdjust Ogre::ColourFaderAffector::msBlueCmd

static

Definition at line 135 of file OgreColourFaderAffector.h.

CmdGreenAdjust Ogre::ColourFaderAffector::msGreenCmd

static

Definition at line 134 of file OgreColourFaderAffector.h.

CmdRedAdjust Ogre::ColourFaderAffector::msRedCmd

static

Definition at line 133 of file OgreColourFaderAffector.h.

String Ogre::ParticleAffector::mType

protectedinherited

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

Definition at line 67 of file OgreParticleAffector.h.

---

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

• OgreColourFaderAffector.h