Ogre::ColourFaderAffector2FX2 Class Reference

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

#include <OgreColourFaderAffector2FX2.h>

Inheritance diagram for Ogre::ColourFaderAffector2FX2:

Public Member Functions
	ColourFaderAffector2FX2 ()
void	_cloneFrom (const ParticleAffector2 *original) override
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
const Vector4 &	getMaxColour () const
const Vector4 &	getMinColour () const
float	getRedAdjust1 () const
	Gets the red adjustment to be made per second to particles. *‍/. More...
float	getRedAdjust2 () const
Real	getStateChange () const
String	getType () const override
	Returns the name of the type of affector. More...
void	run (ParticleCpuData cpuData, size_t numParticles, ArrayReal timeSinceLast) const override
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	setMaxColour (const Vector4 &rgba)
	Sets the maximum value to which the particles will be clamped against. More...
void	setMinColour (const Vector4 &rgba)
	Sets the minimum value to which the particles will be clamped against. 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)
Public Member Functions inherited from Ogre::ParticleAffector2
virtual void	initEmittedParticles (ParticleCpuData, const EmittedParticle *, size_t) const
	Initializes particles Can be called by multiple threads. More...
virtual bool	needsInitialization () const
	Returns true if initEmittedParticles() must be called on a particle that has been emitted. More...
virtual void	oneTimeInit ()
virtual bool	wantsRotation () const
	Returns true if ParticleSystemDef should default to something else other than ParticleRotationType::None. 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...
ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary () const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters () 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...

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

ColourFaderAffector2FX2()

Ogre::ColourFaderAffector2FX2::ColourFaderAffector2FX2

(

)

Member Function Documentation

_cloneFrom()

void Ogre::ColourFaderAffector2FX2::_cloneFrom ( const ParticleAffector2 *  original )

overridevirtual

Implements Ogre::ParticleAffector2.

getAlphaAdjust1()

float Ogre::ColourFaderAffector2FX2::getAlphaAdjust1

(

)

const

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

getAlphaAdjust2()

float Ogre::ColourFaderAffector2FX2::getAlphaAdjust2

(

)

const

getBlueAdjust1()

float Ogre::ColourFaderAffector2FX2::getBlueAdjust1

(

)

const

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

getBlueAdjust2()

float Ogre::ColourFaderAffector2FX2::getBlueAdjust2

(

)

const

getGreenAdjust1()

float Ogre::ColourFaderAffector2FX2::getGreenAdjust1

(

)

const

Gets the green adjustment to be made per second to particles. *‍/.

getGreenAdjust2()

float Ogre::ColourFaderAffector2FX2::getGreenAdjust2

(

)

const

getMaxColour()

const Vector4& Ogre::ColourFaderAffector2FX2::getMaxColour

(

)

const

getMinColour()

const Vector4& Ogre::ColourFaderAffector2FX2::getMinColour

(

)

const

getRedAdjust1()

float Ogre::ColourFaderAffector2FX2::getRedAdjust1

(

)

const

Gets the red adjustment to be made per second to particles. *‍/.

getRedAdjust2()

float Ogre::ColourFaderAffector2FX2::getRedAdjust2

(

)

const

getStateChange()

Real Ogre::ColourFaderAffector2FX2::getStateChange

(

)

const

getType()

String Ogre::ColourFaderAffector2FX2::getType ( ) const

overridevirtual

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.

Implements Ogre::ParticleAffector2.

run()

void Ogre::ColourFaderAffector2FX2::run ( ParticleCpuData  cpuData, size_t  numParticles, ArrayReal  timeSinceLast  ) const

overridevirtual

Implements Ogre::ParticleAffector2.

setAdjust1()

void Ogre::ColourFaderAffector2FX2::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,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.

setAdjust2()

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

setAlphaAdjust1()

void Ogre::ColourFaderAffector2FX2::setAlphaAdjust1

(

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.

setAlphaAdjust2()

void Ogre::ColourFaderAffector2FX2::setAlphaAdjust2

(

float

alpha

)

setBlueAdjust1()

void Ogre::ColourFaderAffector2FX2::setBlueAdjust1

(

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.

setBlueAdjust2()

void Ogre::ColourFaderAffector2FX2::setBlueAdjust2

(

float

blue

)

setGreenAdjust1()

void Ogre::ColourFaderAffector2FX2::setGreenAdjust1

(

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.

setGreenAdjust2()

void Ogre::ColourFaderAffector2FX2::setGreenAdjust2

(

float

green

)

setMaxColour()

void Ogre::ColourFaderAffector2FX2::setMaxColour

(

const Vector4 &

rgba

)

Sets the maximum value to which the particles will be clamped against.

Parameters

rgba	RGBA components stored in xyzw.

setMinColour()

void Ogre::ColourFaderAffector2FX2::setMinColour

(

const Vector4 &

rgba

)

Sets the minimum value to which the particles will be clamped against.

Parameters

rgba	RGBA components stored in xyzw.

setRedAdjust1()

void Ogre::ColourFaderAffector2FX2::setRedAdjust1

(

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.

setRedAdjust2()

void Ogre::ColourFaderAffector2FX2::setRedAdjust2

(

float

red

)

setStateChange()

void Ogre::ColourFaderAffector2FX2::setStateChange

(

Real

NewValue

)

---

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

• OgreColourFaderAffector2FX2.h