ParticleUniverse::DoEnableComponentEventHandler Class Reference

#include <ParticleUniverseDoEnableComponentEventHandler.h>

Inheritance diagram for ParticleUniverse::DoEnableComponentEventHandler:

Public Member Functions
	DoEnableComponentEventHandler (void)
virtual	~DoEnableComponentEventHandler (void)
const String &	getComponentName (void) const
void	setComponentName (const String &componentName)
bool	isComponentEnabled (void) const
void	setComponentEnabled (bool enabled)
ComponentType	getComponentType (void) const
void	setComponentType (ComponentType componentType)
virtual void	_handle (ParticleTechnique *particleTechnique, Particle *particle, Real timeElapsed)
virtual void	copyAttributesTo (ParticleEventHandler *eventHandler)
Public Member Functions inherited from ParticleUniverse::ParticleEventHandler
	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	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
String	mComponentName
ComponentType	mComponentType
bool	mComponentEnabled
Protected Attributes inherited from ParticleUniverse::ParticleEventHandler
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

This class makes it possible to enable or disable a Component. This component is an named emitter, affector or technique.

Constructor & Destructor Documentation

ParticleUniverse::DoEnableComponentEventHandler::DoEnableComponentEventHandler

(

void

)

virtual ParticleUniverse::DoEnableComponentEventHandler::~DoEnableComponentEventHandler ( void  )

inlinevirtual

Member Function Documentation

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

virtual

If the _handle() function of this class is invoked (by an Observer), it searches the ParticleEmitter, ParticleAffector or ParticleTechnique defined by the its name. The ParticleEmitter/Affector is either part of the ParticleTechnique in which the DoEnableComponentEventHandler is defined, or if the ParticleEmitter/Affector is not found, other ParticleTechniques are searched.

Implements ParticleUniverse::ParticleEventHandler.

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

virtual

Copy attributes to another event handler.

Reimplemented from ParticleUniverse::ParticleEventHandler.

const String& ParticleUniverse::DoEnableComponentEventHandler::getComponentName ( void  ) const

inline

Get the name of the component that must be enabled or disabled.

ComponentType ParticleUniverse::DoEnableComponentEventHandler::getComponentType ( void  ) const

inline

Get the value that identifies whether the component must be enabled or disabled.

bool ParticleUniverse::DoEnableComponentEventHandler::isComponentEnabled ( void  ) const

inline

Get the value that identifies whether the component must be enabled or disabled.

void ParticleUniverse::DoEnableComponentEventHandler::setComponentEnabled ( bool  enabled )

inline

Set the value that identifies whether the component must be enabled or disabled.

void ParticleUniverse::DoEnableComponentEventHandler::setComponentName ( const String &  componentName )

inline

Set the name of the component that must be enabled or disables.

void ParticleUniverse::DoEnableComponentEventHandler::setComponentType ( ComponentType  componentType )

inline

Set the value that identifies whether the component must be enabled or disabled.

Member Data Documentation

bool ParticleUniverse::DoEnableComponentEventHandler::mComponentEnabled

protected

Determines whether the Component must be enabled or disabled.

String ParticleUniverse::DoEnableComponentEventHandler::mComponentName

protected

ComponentType ParticleUniverse::DoEnableComponentEventHandler::mComponentType

protected

---

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

• ParticleEventHandlers/ParticleUniverseDoEnableComponentEventHandler.h