#include <ParticleUniverseGeometryRotator.h>

Inheritance diagram for ParticleUniverse::GeometryRotator:

[legend]

Public Member Functions
	GeometryRotator (void)

virtual	~GeometryRotator (void)

DynamicAttribute *	getRotationSpeed (void) const

void	setRotationSpeed (DynamicAttribute *dynRotationSpeed)

bool	useOwnRotationSpeed (void) const

void	setUseOwnRotationSpeed (bool useOwnRotationSpeed)

const Vector3 &	getRotationAxis (void) const

void	setRotationAxis (const Vector3 &rotationAxis)

void	resetRotationAxis (void)

Real	_calculateRotationSpeed (Particle *particle)

virtual void	copyAttributesTo (ParticleAffector *affector)

virtual void	_initParticleForEmission (Particle *particle)

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

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

static const Real	DEFAULT_ROTATION_SPEED

static const Vector3	DEFAULT_ROTATION_AXIS

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	mScaledRotationSpeed

bool	mUseOwnRotationSpeed

DynamicAttribute *	mDynRotationSpeed

Quaternion	mQ

Vector3	mRotationAxis

bool	mRotationAxisSet

DynamicAttributeFactory	mDynamicAttributeFactory

DynamicAttributeHelper	mDynamicAttributeHelper

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 GeometryRotator rotates particles around its orientation axis. The rotation speed can be adjusted and can be set to a 'global' rotation speed, which affects all particles in the Particle Technique the same way. It is also possible to use the rotation speed of the particles itself.

Constructor & Destructor Documentation

ParticleUniverse::GeometryRotator::GeometryRotator ( void )

virtual ParticleUniverse::GeometryRotator::~GeometryRotator ( void )

virtual

Member Function Documentation

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

Real ParticleUniverse::GeometryRotator::_calculateRotationSpeed ( Particle * particle )

Returns a rotation speed value, depending on the type of dynamic attribute.

virtual void ParticleUniverse::GeometryRotator::_initParticleForEmission ( Particle * particle )

virtual

Initialise a newly emitted particle.

Parameters

particle Pointer to a Particle to initialise.

Reimplemented from ParticleUniverse::ParticleAffector.

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

virtual

Copy attributes to another affector.

Reimplemented from ParticleUniverse::ParticleAffector.

const Vector3& ParticleUniverse::GeometryRotator::getRotationAxis ( void ) const

DynamicAttribute* ParticleUniverse::GeometryRotator::getRotationSpeed ( void ) const

Returns the rotation speed. This is the speed controlled by the affector. Besides the default rotation speed, it is also possible to use the particles own rotation speed.

void ParticleUniverse::GeometryRotator::resetRotationAxis ( void )

void ParticleUniverse::GeometryRotator::setRotationAxis ( const Vector3 & rotationAxis )

void ParticleUniverse::GeometryRotator::setRotationSpeed ( DynamicAttribute * dynRotationSpeed )

void ParticleUniverse::GeometryRotator::setUseOwnRotationSpeed ( bool useOwnRotationSpeed )

Set the indication whether rotation speed of the particle itself is used.

bool ParticleUniverse::GeometryRotator::useOwnRotationSpeed ( void ) const

Returns an indication whether the rotation speed is the same for all particles in this particle technique, or whether the rotation speed of the particle itself is used.

Member Data Documentation

const Vector3 ParticleUniverse::GeometryRotator::DEFAULT_ROTATION_AXIS

static

const Real ParticleUniverse::GeometryRotator::DEFAULT_ROTATION_SPEED

static

const bool ParticleUniverse::GeometryRotator::DEFAULT_USE_OWN

static

DynamicAttributeFactory ParticleUniverse::GeometryRotator::mDynamicAttributeFactory

protected

Helper factory

DynamicAttributeHelper ParticleUniverse::GeometryRotator::mDynamicAttributeHelper

protected

DynamicAttribute* ParticleUniverse::GeometryRotator::mDynRotationSpeed

protected

Quaternion ParticleUniverse::GeometryRotator::mQ

protected

Vector3 ParticleUniverse::GeometryRotator::mRotationAxis

protected

bool ParticleUniverse::GeometryRotator::mRotationAxisSet

protected

Real ParticleUniverse::GeometryRotator::mScaledRotationSpeed

protected

bool ParticleUniverse::GeometryRotator::mUseOwnRotationSpeed

protected

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

ParticleAffectors/ParticleUniverseGeometryRotator.h

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation