ParticleUniverse::ColourAffector Class Reference

#include <ParticleUniverseColourAffector.h>

Inheritance diagram for ParticleUniverse::ColourAffector:

Public Types
enum	ColourOperation { CAO_MULTIPLY, CAO_SET }
typedef map< Real, ColourValue >	ColourMap
typedef map< Real, ColourValue >::iterator	ColourMapIterator
Public Types inherited from ParticleUniverse::ParticleAffector
enum	AffectSpecialisation { AFSP_DEFAULT, AFSP_TTL_INCREASE, AFSP_TTL_DECREASE }
Public Types inherited from ParticleUniverse::Particle
enum	ParticleType {   PT_VISUAL, PT_TECHNIQUE, PT_EMITTER, PT_AFFECTOR,   PT_SYSTEM }
enum	ReservedParticleEventFlags { PEF_EXPIRED = 1<<0, PEF_EMITTED = 1<<1, PEF_COLLIDED = 1<<2 }
typedef vector< ParticleBehaviour * >	ParticleBehaviourList
typedef ParticleBehaviourList::const_iterator	ParticleBehaviourIterator
Public Types inherited from ParticleUniverse::IAlias
enum	AliasType {   AT_UNDEFINED, AT_TECHNIQUE, AT_RENDERER, AT_EMITTER,   AT_AFFECTOR, AT_OBSERVER, AT_EXTERN, AT_HANDLER,   AT_BEHAVIOUR }

Public Member Functions
	ColourAffector (void)
virtual	~ColourAffector (void)
void	addColour (Real timeFraction, const ColourValue &colour)
const ColourMap &	getTimeAndColour (void) const
void	clearColourMap (void)
ColourMapIterator	_findNearestColourMapIterator (Real timeFraction)
const ColourOperation &	getColourOperation (void) const
void	setColourOperation (const ColourOperation &colourOperation)
virtual void	_affect (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
virtual void	copyAttributesTo (ParticleAffector *affector)
Public Member Functions inherited from ParticleUniverse::ParticleAffector
	ParticleAffector (void)
virtual	~ParticleAffector (void)
const AffectSpecialisation &	getAffectSpecialisation (void) const
void	setAffectSpecialisation (const AffectSpecialisation &affectSpecialisation)
const String &	getAffectorType (void) const
void	setAffectorType (const String &affectorType)
const String &	getName (void) const
void	setName (const String &name)
ParticleTechnique *	getParentTechnique (void) const
void	setParentTechnique (ParticleTechnique *parentTechnique)
virtual void	_prepare (ParticleTechnique *particleTechnique)
virtual void	_unprepare (ParticleTechnique *particleTechnique)
virtual void	_notifyStart (void)
virtual void	_notifyStop (void)
virtual void	_notifyPause (void)
virtual void	_notifyResume (void)
virtual void	_notifyRescaled (const Vector3 &scale)
virtual void	_preProcessParticles (ParticleTechnique *particleTechnique, Real timeElapsed)
virtual void	_firstParticle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
virtual void	_initForEmission (void)
virtual void	_initForExpiration (ParticleTechnique *technique, Real timeElapsed)
virtual void	_initParticleForEmission (Particle *particle)
void	_processParticle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed, bool firstParticle)
virtual void	_postProcessParticles (ParticleTechnique *technique, Real timeElapsed)
void	addEmitterToExclude (const String &emitterName)
void	removeEmitterToExclude (const String &emitterName)
void	removeAllEmittersToExclude (void)
const list< String > &	getEmittersToExclude (void) const
bool	hasEmitterToExclude (const String &emitterName)
virtual void	copyParentAttributesTo (ParticleAffector *affector)
const Vector3 &	getDerivedPosition (void)
Real	_calculateAffectSpecialisationFactor (const Particle *particle)
Public Member Functions inherited from ParticleUniverse::Particle
	Particle (void)
virtual	~Particle (void)
bool	_isMarkedForEmission (void) const
void	_setMarkedForEmission (bool markedForEmission)
virtual bool	isEnabled (void) const
virtual void	setEnabled (bool enabled)
void	_setOriginalEnabled (bool originalEnabled)
bool	_getOriginalEnabled (void) const
bool	isFreezed (void) const
void	setFreezed (bool freezed)
void	setEventFlags (uint32 flags)
void	addEventFlags (uint32 flags)
void	removeEventFlags (uint32 flags)
uint32	getEventFlags (void) const
bool	hasEventFlags (uint32 flags) const
void	copyBehaviours (ParticleBehaviourList &behaviours)
virtual void	_process (ParticleTechnique *technique, Real timeElapsed)
ParticleBehaviour *	getBehaviour (const String &behaviourType)
Real	calculateVelocity (void) const
virtual void	copyAttributesTo (Particle *particle)
Public Member Functions inherited from ParticleUniverse::IAlias
	IAlias (void)
virtual	~IAlias (void)
const String &	getAliasName (void) const
void	setAliasName (String aliasName)
const AliasType	getAliasType (void) const
void	setAliasType (AliasType aliasType)
Public Member Functions inherited from ParticleUniverse::IElement
	IElement (void)
virtual	~IElement (void)

Static Public Attributes
static const ColourOperation	DEFAULT_COLOUR_OPERATION
Static Public Attributes inherited from ParticleUniverse::ParticleAffector
static const bool	DEFAULT_ENABLED
static const Vector3	DEFAULT_POSITION
static const AffectSpecialisation	DEFAULT_SPECIALISATION
Static Public Attributes inherited from ParticleUniverse::Particle
static Real	DEFAULT_TTL
static Real	DEFAULT_MASS

Protected Attributes
ColourMap	mColourMap
ColourOperation	mColourOperation
Protected Attributes inherited from ParticleUniverse::ParticleAffector
ParticleTechnique *	mParentTechnique
String	mAffectorType
String	mName
AffectSpecialisation	mAffectSpecialisation
list< String >	mExcludedEmitters
Vector3	_mAffectorScale
Protected Attributes inherited from ParticleUniverse::Particle
uint32	mEventFlags
bool	mMarkedForEmission
bool	mEnabled
bool	mFreezed
bool	mOriginalEnabled
bool	mOriginalEnabledSet
Vector3	mDerivedPosition
ParticleBehaviourList	mBehaviours
Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName
AliasType	mAliasType

Additional Inherited Members
Public Attributes inherited from ParticleUniverse::Particle
ParticleEmitter *	parentEmitter
Vector3	position
Vector3	direction
Real	mass
Real	timeToLive
Real	totalTimeToLive
Real	timeFraction
ParticleType	particleType
Any	mUserDefinedObject
PhysicsActor *	physicsActor
IVisualData *	visualData
Vector3	originalPosition
Vector3	originalDirection
Real	originalVelocity
Real	originalDirectionLength
Real	originalScaledDirectionLength
Vector3	latestPosition

Detailed Description

This affector is typically used to change the colour of a particle during its lifetime.

Member Typedef Documentation

typedef map<Real, ColourValue> ParticleUniverse::ColourAffector::ColourMap

typedef map<Real, ColourValue>::iterator ParticleUniverse::ColourAffector::ColourMapIterator

Member Enumeration Documentation

enum ParticleUniverse::ColourAffector::ColourOperation

Enumerator
CAO_MULTIPLY
CAO_SET

Constructor & Destructor Documentation

ParticleUniverse::ColourAffector::ColourAffector

(

void

)

virtual ParticleUniverse::ColourAffector::~ColourAffector ( void  )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::ColourAffector::_affect ( ParticleTechnique *  particleTechnique, Particle *  particle, Real  timeElapsed  )

virtual

Affect a particle.

Parameters

particle	Pointer to a ParticleTechnique to which the particle belongs.
particle	Pointer to a Particle.
timeElapsed	The number of seconds which have elapsed since the last call.

Implements ParticleUniverse::ParticleAffector.

ColourMapIterator ParticleUniverse::ColourAffector::_findNearestColourMapIterator ( Real  timeFraction )

inline

void ParticleUniverse::ColourAffector::addColour	(	Real	timeFraction,
		const ColourValue &	colour
	)

void ParticleUniverse::ColourAffector::clearColourMap

(

void

)

virtual void ParticleUniverse::ColourAffector::copyAttributesTo ( ParticleAffector *  affector )

virtual

Copy attributes to another affector.

Reimplemented from ParticleUniverse::ParticleAffector.

const ColourOperation& ParticleUniverse::ColourAffector::getColourOperation

(

void

)

const

const ColourMap& ParticleUniverse::ColourAffector::getTimeAndColour

(

void

)

const

void ParticleUniverse::ColourAffector::setColourOperation

(

const ColourOperation &

colourOperation

)

Member Data Documentation

const ColourOperation ParticleUniverse::ColourAffector::DEFAULT_COLOUR_OPERATION

static

ColourMap ParticleUniverse::ColourAffector::mColourMap

protected

ColourOperation ParticleUniverse::ColourAffector::mColourOperation

protected

---

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

• ParticleAffectors/ParticleUniverseColourAffector.h