#include <ParticleUniverseOnPositionObserver.h>

Inheritance diagram for ParticleUniverse::OnPositionObserver:

Public Member Functions
	OnPositionObserver (void)

virtual	~OnPositionObserver (void)

virtual bool	_observe (ParticleTechnique particleTechnique, Particle particle, Real timeElapsed)

void	setPositionXThreshold (Real threshold)

void	setPositionYThreshold (Real threshold)

void	setPositionZThreshold (Real threshold)

Real	getPositionXThreshold (void) const

Real	getPositionYThreshold (void) const

Real	getPositionZThreshold (void) const

bool	isPositionXThresholdSet (void) const

bool	isPositionYThresholdSet (void) const

bool	isPositionZThresholdSet (void) const

void	resetPositionXThreshold (void)

void	resetPositionYThreshold (void)

void	resetPositionZThreshold (void)

void	setComparePositionX (ComparisionOperator op)

void	setComparePositionY (ComparisionOperator op)

void	setComparePositionZ (ComparisionOperator op)

const ComparisionOperator	getComparePositionX (void) const

const ComparisionOperator	getComparePositionY (void) const

const ComparisionOperator	getComparePositionZ (void) const

virtual void	copyAttributesTo (ParticleObserver *observer)

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

virtual	~ParticleObserver (void)

const String &	getObserverType (void) const

void	setObserverType (const String &observerType)

virtual bool	isEnabled (void) const

bool	_getOriginalEnabled (void) const

virtual void	setEnabled (bool enabled)

void	_resetEnabled (void)

ParticleTechnique *	getParentTechnique (void) const

void	setParentTechnique (ParticleTechnique *parentTechnique)

const String &	getName (void) const

void	setName (const String &name)

const Particle::ParticleType &	getParticleTypeToObserve (void) const

void	setParticleTypeToObserve (const Particle::ParticleType particleTypeToObserve)

virtual void	_notifyStart (void)

virtual void	_notifyStop (void)

virtual void	_notifyRescaled (const Vector3 &scale)

virtual void	_preProcessParticles (ParticleTechnique *technique, Real timeElapsed)

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

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

virtual void	_postProcessParticles (ParticleTechnique *technique, Real timeElapsed)

ParticleEventHandler *	createEventHandler (const String &eventHandlerType)

void	addEventHandler (ParticleEventHandler *eventHandler)

void	removeEventHandler (ParticleEventHandler *eventHandler)

ParticleEventHandler *	getEventHandler (size_t index) const

ParticleEventHandler *	getEventHandler (const String &eventHandlerName) const

size_t	getNumEventHandlers (void) const

void	destroyEventHandler (ParticleEventHandler *eventHandler)

void	destroyEventHandler (size_t index)

void	destroyAllEventHandlers (void)

virtual void	copyParentAttributesTo (ParticleObserver *observer)

Real	getObserverInterval (void) const

void	setObserverInterval (Real observerInterval)

bool	getObserveUntilEvent (void) const

void	setObserveUntilEvent (bool observeUntilEvent)

bool	isParticleTypeToObserveSet (void) const

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_POSITION_THRESHOLD

Static Public Attributes inherited from ParticleUniverse::ParticleObserver
static const bool	DEFAULT_ENABLED

static const Particle::ParticleType	DEFAULT_PARTICLE_TYPE

static const Real	DEFAULT_INTERVAL

static const bool	DEFAULT_UNTIL_EVENT

Protected Attributes
Real	mPositionXThreshold

Real	mPositionYThreshold

Real	mPositionZThreshold

bool	mPositionXThresholdSet

bool	mPositionYThresholdSet

bool	mPositionZThresholdSet

ComparisionOperator	mComparePositionX

ComparisionOperator	mComparePositionY

ComparisionOperator	mComparePositionZ

Protected Attributes inherited from ParticleUniverse::ParticleObserver
ParticleTechnique *	mParentTechnique

String	mObserverType

String	mName

bool	mEnabled

bool	mOriginalEnabled

bool	mOriginalEnabledSet

bool	mObserve

bool	mObserveUntilEvent

bool	mEventHandlersExecuted

Vector3	_mObserverScale

Particle::ParticleType	mParticleTypeToObserve

bool	mParticleTypeToObserveSet

ParticleEventHandlerList	mEventHandlers

Real	mObserverInterval

Real	mObserverIntervalRemainder

bool	mObserverIntervalSet

Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName

AliasType	mAliasType

Additional Inherited Members
Public Types inherited from ParticleUniverse::ParticleObserver
typedef vector< ParticleEventHandler * >::iterator	ParticleEventHandlerIterator

typedef vector< ParticleEventHandler * >::const_iterator	ParticleEventHandlerConstIterator

typedef vector< ParticleEventHandler * >	ParticleEventHandlerList

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 }

Protected Member Functions inherited from ParticleUniverse::ParticleObserver
virtual void	_handleObserve (ParticleTechnique particleTechnique, Particle particle, Real timeElapsed)

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

Detailed Description

This class is used to observe whether a Particle reaches a certain position.

Constructor & Destructor Documentation

ParticleUniverse::OnPositionObserver::OnPositionObserver ( void )

virtual ParticleUniverse::OnPositionObserver::~OnPositionObserver ( void )

inlinevirtual

Member Function Documentation

virtual bool ParticleUniverse::OnPositionObserver::_observe	(	ParticleTechnique *	particleTechnique,
		Particle *	particle,
		Real	timeElapsed
	)

virtual

This function determines whether a condition (the event) is true or false.

Implements ParticleUniverse::ParticleObserver.

virtual void ParticleUniverse::OnPositionObserver::copyAttributesTo ( ParticleObserver * observer )

virtual

Copy attributes to another observer.

Reimplemented from ParticleUniverse::ParticleObserver.

const ComparisionOperator ParticleUniverse::OnPositionObserver::getComparePositionX ( void ) const

inline

const ComparisionOperator ParticleUniverse::OnPositionObserver::getComparePositionY ( void ) const

inline

const ComparisionOperator ParticleUniverse::OnPositionObserver::getComparePositionZ ( void ) const

inline

Real ParticleUniverse::OnPositionObserver::getPositionXThreshold ( void ) const

inline

Real ParticleUniverse::OnPositionObserver::getPositionYThreshold ( void ) const

inline

Real ParticleUniverse::OnPositionObserver::getPositionZThreshold ( void ) const

inline

bool ParticleUniverse::OnPositionObserver::isPositionXThresholdSet ( void ) const

inline

bool ParticleUniverse::OnPositionObserver::isPositionYThresholdSet ( void ) const

inline

bool ParticleUniverse::OnPositionObserver::isPositionZThresholdSet ( void ) const

inline

void ParticleUniverse::OnPositionObserver::resetPositionXThreshold ( void )

inline

void ParticleUniverse::OnPositionObserver::resetPositionYThreshold ( void )

inline

void ParticleUniverse::OnPositionObserver::resetPositionZThreshold ( void )

inline

void ParticleUniverse::OnPositionObserver::setComparePositionX ( ComparisionOperator op )

inline

void ParticleUniverse::OnPositionObserver::setComparePositionY ( ComparisionOperator op )

inline

void ParticleUniverse::OnPositionObserver::setComparePositionZ ( ComparisionOperator op )

inline

void ParticleUniverse::OnPositionObserver::setPositionXThreshold ( Real threshold )

inline

void ParticleUniverse::OnPositionObserver::setPositionYThreshold ( Real threshold )

inline

void ParticleUniverse::OnPositionObserver::setPositionZThreshold ( Real threshold )

inline

Member Data Documentation

const Vector3 ParticleUniverse::OnPositionObserver::DEFAULT_POSITION_THRESHOLD

static

ComparisionOperator ParticleUniverse::OnPositionObserver::mComparePositionX

protected

ComparisionOperator ParticleUniverse::OnPositionObserver::mComparePositionY

protected

ComparisionOperator ParticleUniverse::OnPositionObserver::mComparePositionZ

protected

Real ParticleUniverse::OnPositionObserver::mPositionXThreshold

protected

bool ParticleUniverse::OnPositionObserver::mPositionXThresholdSet

protected

Real ParticleUniverse::OnPositionObserver::mPositionYThreshold

protected

bool ParticleUniverse::OnPositionObserver::mPositionYThresholdSet

protected

Real ParticleUniverse::OnPositionObserver::mPositionZThreshold

protected

bool ParticleUniverse::OnPositionObserver::mPositionZThresholdSet

protected

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

ParticleObservers/ParticleUniverseOnPositionObserver.h

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation