ParticleUniverse::OnTimeObserver Class Reference

#include <ParticleUniverseOnTimeObserver.h>

Inheritance diagram for ParticleUniverse::OnTimeObserver:

Public Member Functions
	OnTimeObserver (void)
virtual	~OnTimeObserver (void)
virtual void	_preProcessParticles (ParticleTechnique *technique, Real timeElapsed)
virtual bool	_observe (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
Real	getThreshold (void) const
void	setThreshold (Real threshold)
const ComparisionOperator	getCompare (void) const
void	setCompare (ComparisionOperator op)
bool	isSinceStartSystem (void) const
void	setSinceStartSystem (bool sinceStartSystem)
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	_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 Real	DEFAULT_THRESHOLD
static const bool	DEFAULT_SINCE_START_SYSTEM
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	mThreshold
ComparisionOperator	mCompare
bool	mSinceStartSystem
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

The OnTimeObserver observers how much time has been elapsed. This can be both the particles own time and the time since the ParticleSystem was started.

Constructor & Destructor Documentation

ParticleUniverse::OnTimeObserver::OnTimeObserver

(

void

)

virtual ParticleUniverse::OnTimeObserver::~OnTimeObserver ( void  )

inlinevirtual

Member Function Documentation

virtual bool ParticleUniverse::OnTimeObserver::_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::OnTimeObserver::_preProcessParticles ( ParticleTechnique *  technique, Real  timeElapsed  )

virtual

In case there are no particles, but the observation returns true, the event handlers must still be called.

Reimplemented from ParticleUniverse::ParticleObserver.

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

virtual

Copy attributes to another observer.

Reimplemented from ParticleUniverse::ParticleObserver.

const ComparisionOperator ParticleUniverse::OnTimeObserver::getCompare ( void  ) const

inline

Real ParticleUniverse::OnTimeObserver::getThreshold ( void  ) const

inline

bool ParticleUniverse::OnTimeObserver::isSinceStartSystem ( void  ) const

inline

void ParticleUniverse::OnTimeObserver::setCompare ( ComparisionOperator  op )

inline

void ParticleUniverse::OnTimeObserver::setSinceStartSystem ( bool  sinceStartSystem )

inline

void ParticleUniverse::OnTimeObserver::setThreshold ( Real  threshold )

inline

Member Data Documentation

const bool ParticleUniverse::OnTimeObserver::DEFAULT_SINCE_START_SYSTEM

static

const Real ParticleUniverse::OnTimeObserver::DEFAULT_THRESHOLD

static

ComparisionOperator ParticleUniverse::OnTimeObserver::mCompare

protected

bool ParticleUniverse::OnTimeObserver::mSinceStartSystem

protected

Real ParticleUniverse::OnTimeObserver::mThreshold

protected

---

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

• ParticleObservers/ParticleUniverseOnTimeObserver.h