#include <ParticleUniverseLineAffector.h>

Inheritance diagram for ParticleUniverse::LineAffector:

[legend]

Public Member Functions
	LineAffector (void)

virtual	~LineAffector (void)

Real	getMaxDeviation (void) const

void	setMaxDeviation (Real maxDeviation)

const Vector3 &	getEnd (void) const

void	setEnd (const Vector3 &end)

Real	getTimeStep (void) const

void	setTimeStep (Real timeStep)

Real	getDrift (void) const

void	setDrift (Real drift)

virtual void	_notifyRescaled (const Vector3 &scale)

virtual void	_firstParticle (ParticleTechnique particleTechnique, Particle particle, Real timeElapsed)

virtual void	_preProcessParticles (ParticleTechnique *particleTechnique, Real timeElapsed)

virtual void	_affect (ParticleTechnique particleTechnique, Particle particle, Real timeElapsed)

virtual void	_postProcessParticles (ParticleTechnique *technique, 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	_initForEmission (void)

virtual void	_initForExpiration (ParticleTechnique *technique, Real timeElapsed)

virtual void	_initParticleForEmission (Particle *particle)

void	_processParticle (ParticleTechnique particleTechnique, Particle particle, Real timeElapsed, bool firstParticle)

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 Real	DEFAULT_MAX_DEVIATION

static const Real	DEFAULT_TIME_STEP

static const Vector3	DEFAULT_END

static const Real	DEFAULT_DRIFT

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
Real	mMaxDeviation

Real	_mScaledMaxDeviation

Vector3	mEnd

Real	mTimeSinceLastUpdate

Real	mTimeStep

Real	mDrift

Real	mOneMinusDrift

bool	mUpdate

bool	mFirst

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

Affects a particle depending on a line shape. Particles are getting a new position along the line.

Constructor & Destructor Documentation

ParticleUniverse::LineAffector::LineAffector ( void )

virtual ParticleUniverse::LineAffector::~LineAffector ( void )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::LineAffector::_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.

virtual void ParticleUniverse::LineAffector::_firstParticle	(	ParticleTechnique *	particleTechnique,
		Particle *	particle,
		Real	timeElapsed
	)

virtual

Perform precalculations if the first Particle in the update-loop is processed.

Reimplemented from ParticleUniverse::ParticleAffector.

virtual void ParticleUniverse::LineAffector::_notifyRescaled ( const Vector3 & scale )

virtual

Notify that the Affector is rescaled.

Reimplemented from ParticleUniverse::ParticleAffector.

virtual void ParticleUniverse::LineAffector::_postProcessParticles	(	ParticleTechnique *	technique,
		Real	timeElapsed
	)

virtual

Perform activities after the individual particles are processed.

Remarks: This function is called after the ParticleTechnique update-loop where all particles are traversed.

Reimplemented from ParticleUniverse::ParticleAffector.

virtual void ParticleUniverse::LineAffector::_preProcessParticles	(	ParticleTechnique *	particleTechnique,
		Real	timeElapsed
	)

virtual

Perform activities before the individual particles are processed.

Remarks: This function is called before the ParticleTechnique update-loop where all particles are traversed. the preProcess is typically used to perform calculations where the result must be used in processing each individual particle.

Reimplemented from ParticleUniverse::ParticleAffector.

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

virtual

Copy attributes to another affector.

Reimplemented from ParticleUniverse::ParticleAffector.

Real ParticleUniverse::LineAffector::getDrift ( void ) const

const Vector3& ParticleUniverse::LineAffector::getEnd ( void ) const

Real ParticleUniverse::LineAffector::getMaxDeviation ( void ) const

Real ParticleUniverse::LineAffector::getTimeStep ( void ) const

void ParticleUniverse::LineAffector::setDrift ( Real drift )

void ParticleUniverse::LineAffector::setEnd ( const Vector3 & end )

void ParticleUniverse::LineAffector::setMaxDeviation ( Real maxDeviation )

void ParticleUniverse::LineAffector::setTimeStep ( Real timeStep )

Member Data Documentation

Real ParticleUniverse::LineAffector::_mScaledMaxDeviation

protected

const Real ParticleUniverse::LineAffector::DEFAULT_DRIFT

static

const Vector3 ParticleUniverse::LineAffector::DEFAULT_END

static

const Real ParticleUniverse::LineAffector::DEFAULT_MAX_DEVIATION

static

const Real ParticleUniverse::LineAffector::DEFAULT_TIME_STEP

static

Real ParticleUniverse::LineAffector::mDrift

protected

Vector3 ParticleUniverse::LineAffector::mEnd

protected

bool ParticleUniverse::LineAffector::mFirst

protected

Real ParticleUniverse::LineAffector::mMaxDeviation

protected

Real ParticleUniverse::LineAffector::mOneMinusDrift

protected

Real ParticleUniverse::LineAffector::mTimeSinceLastUpdate

protected

Real ParticleUniverse::LineAffector::mTimeStep

protected

bool ParticleUniverse::LineAffector::mUpdate

protected

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

ParticleAffectors/ParticleUniverseLineAffector.h

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation