Particle Universe  1.2
Public Member Functions | Protected Attributes | List of all members
ParticleUniverse::OnClearObserver Class Reference

#include <ParticleUniverseOnClearObserver.h>

Inheritance diagram for ParticleUniverse::OnClearObserver:
Inheritance graph
[legend]

Public Member Functions

 OnClearObserver (void)
 
virtual ~OnClearObserver (void)
 
virtual void _notifyStart (void)
 
virtual bool _observe (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
 
virtual void _processParticle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed, bool firstParticle)
 
virtual void _postProcessParticles (ParticleTechnique *technique, Real timeElapsed)
 
- 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 _firstParticle (ParticleTechnique *particleTechnique, Particle *particle, 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 copyAttributesTo (ParticleObserver *observer)
 
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)
 

Protected Attributes

bool mContinue
 
- 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
}
 
- 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 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 all particles of a technique are no longer emitted.

Constructor & Destructor Documentation

ParticleUniverse::OnClearObserver::OnClearObserver ( void  )
inline
virtual ParticleUniverse::OnClearObserver::~OnClearObserver ( void  )
inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::OnClearObserver::_notifyStart ( void  )
virtual

Perform activities when a ParticleTechnique is started.

Reimplemented from ParticleUniverse::ParticleObserver.

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

Instead of the _processParticle(), the _postProcessParticles() is used because it is called even if there isnīt a particle left anymore (and that is the situation we want to validate).

Reimplemented from ParticleUniverse::ParticleObserver.

virtual void ParticleUniverse::OnClearObserver::_processParticle ( ParticleTechnique *  particleTechnique,
Particle *  particle,
Real  timeElapsed,
bool  firstParticle 
)
virtual

The _processParticle() function is overridden, because we donīt observe an individual particle. even if there isnīt a particle left anymore (and that is the situation we want to validate).

Reimplemented from ParticleUniverse::ParticleObserver.

Member Data Documentation

bool ParticleUniverse::OnClearObserver::mContinue
protected
The documentation for this class was generated from the following file: