ParticleUniverse::VortexAffector Class Reference

#include <ParticleUniverseVortexAffector.h>

Inheritance diagram for ParticleUniverse::VortexAffector:

Public Member Functions
	VortexAffector (void)
virtual	~VortexAffector (void)
const Vector3 &	getRotationVector (void) const
void	setRotationVector (const Vector3 &rotationVector)
DynamicAttribute *	getRotationSpeed (void) const
void	setRotationSpeed (DynamicAttribute *dynRotationSpeed)
virtual void	copyAttributesTo (ParticleAffector *affector)
virtual void	_preProcessParticles (ParticleTechnique *particleTechnique, Real timeElapsed)
virtual void	_affect (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
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	_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 Vector3	DEFAULT_ROTATION_VECTOR
static const Real	DEFAULT_ROTATION_SPEED
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 Member Functions
Radian	_calculateRotationSpeed (void)

Protected Attributes
Vector3	mRotationVector
Quaternion	mRotation
DynamicAttribute *	mDynRotationSpeed
DynamicAttributeHelper	mDynamicAttributeHelper
DynamicAttributeFactory	mDynamicAttributeFactory
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

The VortexAffector rotates particles around a given rotation axis.

Constructor & Destructor Documentation

ParticleUniverse::VortexAffector::VortexAffector

(

void

)

virtual ParticleUniverse::VortexAffector::~VortexAffector ( void  )

virtual

Member Function Documentation

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

Radian ParticleUniverse::VortexAffector::_calculateRotationSpeed ( void  )

protected

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

Reimplemented in ParticleUniverse::VortexExtern.

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

virtual

Copy attributes to another affector.

Reimplemented from ParticleUniverse::ParticleAffector.

DynamicAttribute* ParticleUniverse::VortexAffector::getRotationSpeed

(

void

)

const

const Vector3& ParticleUniverse::VortexAffector::getRotationVector

(

void

)

const

void ParticleUniverse::VortexAffector::setRotationSpeed

(

DynamicAttribute *

dynRotationSpeed

)

void ParticleUniverse::VortexAffector::setRotationVector

(

const Vector3 &

rotationVector

)

Member Data Documentation

const Real ParticleUniverse::VortexAffector::DEFAULT_ROTATION_SPEED

static

const Vector3 ParticleUniverse::VortexAffector::DEFAULT_ROTATION_VECTOR

static

DynamicAttributeFactory ParticleUniverse::VortexAffector::mDynamicAttributeFactory

protected

DynamicAttributeHelper ParticleUniverse::VortexAffector::mDynamicAttributeHelper

protected

DynamicAttribute* ParticleUniverse::VortexAffector::mDynRotationSpeed

protected

Quaternion ParticleUniverse::VortexAffector::mRotation

protected

Vector3 ParticleUniverse::VortexAffector::mRotationVector

protected

---

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

• ParticleAffectors/ParticleUniverseVortexAffector.h