ParticleUniverse::ParticleEventHandler Class Reference

#include <ParticleUniverseEventHandler.h>

Inheritance diagram for ParticleUniverse::ParticleEventHandler:

Public Member Functions
	ParticleEventHandler (void)
virtual	~ParticleEventHandler (void)
const String &	getName (void) const
void	setName (const String &name)
ParticleObserver *	getParentObserver (void) const
void	setParentObserver (ParticleObserver *parentObserver)
const String &	getEventHandlerType (void) const
void	setEventHandlerType (const String &eventHandlerType)
virtual void	_notifyRescaled (const Vector3 &scale)
virtual void	_handle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)=0
virtual void	copyAttributesTo (ParticleEventHandler *eventHandler)
virtual void	copyParentAttributesTo (ParticleEventHandler *eventHandler)
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
ParticleObserver *	mParentObserver
String	mEventHandlerType
String	mName
Vector3	_mEventHandlerScale
Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName
AliasType	mAliasType

Additional Inherited Members
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 }

Detailed Description

A ParticleEventHandlers is used to perform a task in case a certain event happens.

Remarks

A ParticleEventHandler is associated with a ParticleObserver; The ParticleObserver signals what event occurs, while the ParticleEventHandler performs some action.

Constructor & Destructor Documentation

ParticleUniverse::ParticleEventHandler::ParticleEventHandler ( void  )

inline

virtual ParticleUniverse::ParticleEventHandler::~ParticleEventHandler ( void  )

inlinevirtual

Member Function Documentation

virtual void ParticleUniverse::ParticleEventHandler::_handle ( ParticleTechnique *  particleTechnique, Particle *  particle, Real  timeElapsed  )

pure virtual

Todo

Implemented in ParticleUniverse::DoPlacementParticleEventHandler, ParticleUniverse::DoEnableComponentEventHandler, ParticleUniverse::DoAffectorEventHandler, ParticleUniverse::DoScaleEventHandler, ParticleUniverse::DoExpireEventHandler, ParticleUniverse::DoFreezeEventHandler, and ParticleUniverse::DoStopSystemEventHandler.

virtual void ParticleUniverse::ParticleEventHandler::_notifyRescaled ( const Vector3 &  scale )

inlinevirtual

Notify that the event handler is rescaled.

virtual void ParticleUniverse::ParticleEventHandler::copyAttributesTo ( ParticleEventHandler *  eventHandler )

inlinevirtual

Copy attributes to another event handler.

Reimplemented in ParticleUniverse::DoPlacementParticleEventHandler, ParticleUniverse::DoEnableComponentEventHandler, ParticleUniverse::DoAffectorEventHandler, and ParticleUniverse::DoScaleEventHandler.

virtual void ParticleUniverse::ParticleEventHandler::copyParentAttributesTo ( ParticleEventHandler *  eventHandler )

inlinevirtual

Copy parent attributes to another event handler.

const String& ParticleUniverse::ParticleEventHandler::getEventHandlerType ( void  ) const

inline

Todo

const String& ParticleUniverse::ParticleEventHandler::getName ( void  ) const

inline

Todo

ParticleObserver* ParticleUniverse::ParticleEventHandler::getParentObserver ( void  ) const

inline

Todo

void ParticleUniverse::ParticleEventHandler::setEventHandlerType ( const String &  eventHandlerType )

inline

void ParticleUniverse::ParticleEventHandler::setName ( const String &  name )

inline

void ParticleUniverse::ParticleEventHandler::setParentObserver ( ParticleObserver *  parentObserver )

inline

Member Data Documentation

Vector3 ParticleUniverse::ParticleEventHandler::_mEventHandlerScale

protected

Although the scale is on a Particle System level, the event handler can also be scaled.

String ParticleUniverse::ParticleEventHandler::mEventHandlerType

protected

String ParticleUniverse::ParticleEventHandler::mName

protected

ParticleObserver* ParticleUniverse::ParticleEventHandler::mParentObserver

protected

---

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

• ParticleUniverseEventHandler.h