ParticleUniverse::OnCountObserver Class Reference

#include <ParticleUniverseOnCountObserver.h>

Inheritance diagram for ParticleUniverse::OnCountObserver:

Public Member Functions
	OnCountObserver (void)
virtual	~OnCountObserver (void)
virtual void	_notifyStart (void)
virtual bool	_observe (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
uint	getThreshold (void) const
void	setThreshold (uint threshold)
const ComparisionOperator	getCompare (void) const
void	setCompare (ComparisionOperator op)
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	_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 uint	DEFAULT_THRESHOLD
static const ComparisionOperator	DEFAULT_COMPARE
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
uint	mCount
uint	mThreshold
ComparisionOperator	mCompare
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 if an x number of Particles have been emitted.

Remarks

OnCountObserver supports 2 possible situations. If the comparison operator is set to 'less than', the _observe() function returns true until the counter exceeds the threshold. If the comparison operator is set to 'greater than', the _observe() function only returns true if the counter exceeds the threshold.

Constructor & Destructor Documentation

ParticleUniverse::OnCountObserver::OnCountObserver

(

void

)

virtual ParticleUniverse::OnCountObserver::~OnCountObserver ( void  )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::OnCountObserver::_notifyStart ( void  )

virtual

Perform activities when a ParticleTechnique is started.

Reimplemented from ParticleUniverse::ParticleObserver.

virtual bool ParticleUniverse::OnCountObserver::_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::OnCountObserver::copyAttributesTo ( ParticleObserver *  observer )

virtual

Copy attributes to another observer.

Reimplemented from ParticleUniverse::ParticleObserver.

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

inline

uint ParticleUniverse::OnCountObserver::getThreshold ( void  ) const

inline

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

inline

void ParticleUniverse::OnCountObserver::setThreshold ( uint  threshold )

inline

Member Data Documentation

const ComparisionOperator ParticleUniverse::OnCountObserver::DEFAULT_COMPARE

static

const uint ParticleUniverse::OnCountObserver::DEFAULT_THRESHOLD

static

ComparisionOperator ParticleUniverse::OnCountObserver::mCompare

protected

uint ParticleUniverse::OnCountObserver::mCount

protected

uint ParticleUniverse::OnCountObserver::mThreshold

protected

---

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

• ParticleObservers/ParticleUniverseOnCountObserver.h