#include <ParticleUniverseSineForceAffector.h>

Inheritance diagram for ParticleUniverse::SineForceAffector:

[legend]

Public Member Functions
	SineForceAffector (void)

virtual	~SineForceAffector (void)

virtual void	copyAttributesTo (ParticleAffector *affector)

virtual void	_preProcessParticles (ParticleTechnique *particleTechnique, Real timeElapsed)

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

const Real	getFrequencyMin (void) const

void	setFrequencyMin (const Real frequencyMin)

const Real	getFrequencyMax (void) const

void	setFrequencyMax (const Real frequencyMax)

Public Member Functions inherited from ParticleUniverse::BaseForceAffector
	BaseForceAffector (void)

virtual	~BaseForceAffector (void)

const Vector3 &	getForceVector (void) const

void	setForceVector (const Vector3 &forceVector)

ForceApplication	getForceApplication (void) const

void	setForceApplication (ForceApplication forceApplication)

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

static const Real	DEFAULT_FREQ_MAX

Static Public Attributes inherited from ParticleUniverse::BaseForceAffector
static const Vector3	DEFAULT_FORCE_VECTOR

static const ForceApplication	DEFAULT_FORCE_APPL

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	mAngle

Real	mFrequencyMin

Real	mFrequencyMax

Real	mFrequency

Protected Attributes inherited from ParticleUniverse::BaseForceAffector
Vector3	mForceVector

Vector3	mScaledVector

ForceApplication	mForceApplication

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::BaseForceAffector
enum	ForceApplication { FA_AVERAGE, FA_ADD }

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

Applies a sine force to a particle.

Constructor & Destructor Documentation

ParticleUniverse::SineForceAffector::SineForceAffector ( void )

virtual ParticleUniverse::SineForceAffector::~SineForceAffector ( void )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::SineForceAffector::_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::SineForceAffector::_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::SineForceAffector::copyAttributesTo ( ParticleAffector * affector )

virtual

Copy attributes to another affector.

Reimplemented from ParticleUniverse::BaseForceAffector.

const Real ParticleUniverse::SineForceAffector::getFrequencyMax ( void ) const

const Real ParticleUniverse::SineForceAffector::getFrequencyMin ( void ) const

void ParticleUniverse::SineForceAffector::setFrequencyMax ( const Real frequencyMax )

void ParticleUniverse::SineForceAffector::setFrequencyMin ( const Real frequencyMin )

Member Data Documentation

const Real ParticleUniverse::SineForceAffector::DEFAULT_FREQ_MAX

static

const Real ParticleUniverse::SineForceAffector::DEFAULT_FREQ_MIN

static

Real ParticleUniverse::SineForceAffector::mAngle

protected

Real ParticleUniverse::SineForceAffector::mFrequency

protected

Real ParticleUniverse::SineForceAffector::mFrequencyMax

protected

Real ParticleUniverse::SineForceAffector::mFrequencyMin

protected

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

ParticleAffectors/ParticleUniverseSineForceAffector.h

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation