ParticleUniverse::DoScaleEventHandler Class Reference

#include <ParticleUniverseDoScaleEventHandler.h>

Inheritance diagram for ParticleUniverse::DoScaleEventHandler:

Public Types
enum	ScaleType { ST_TIME_TO_LIVE, ST_VELOCITY }
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 }

Public Member Functions
	DoScaleEventHandler (void)
virtual	~DoScaleEventHandler (void)
const ScaleType &	getScaleType (void) const
void	setScaleType (const ScaleType &scaleType)
const Real	getScaleFraction (void) const
void	setScaleFraction (const Real scaleFraction)
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)

Static Public Attributes
static const ScaleType	DEFAULT_SCALE_TYPE
static const Real	DEFAULT_SCALE_FRACTION

Protected Attributes
Real	mScaleFraction
ScaleType	mScaleType
Protected Attributes inherited from ParticleUniverse::ParticleEventHandler
ParticleObserver *	mParentObserver
String	mEventHandlerType
String	mName
Vector3	_mEventHandlerScale
Protected Attributes inherited from ParticleUniverse::IAlias
String	mAliasName
AliasType	mAliasType

Detailed Description

The DoScaleEventHandler scales different particle attributes.

Member Enumeration Documentation

enum ParticleUniverse::DoScaleEventHandler::ScaleType

Enumerator
ST_TIME_TO_LIVE
ST_VELOCITY

Constructor & Destructor Documentation

ParticleUniverse::DoScaleEventHandler::DoScaleEventHandler

(

void

)

virtual ParticleUniverse::DoScaleEventHandler::~DoScaleEventHandler ( void  )

inlinevirtual

Member Function Documentation

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

virtual

Todo

Implements ParticleUniverse::ParticleEventHandler.

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

virtual

Copy attributes to another event handler.

Reimplemented from ParticleUniverse::ParticleEventHandler.

const Real ParticleUniverse::DoScaleEventHandler::getScaleFraction

(

void

)

const

Returns the scale fraction

const ScaleType& ParticleUniverse::DoScaleEventHandler::getScaleType

(

void

)

const

Returns the scale type

void ParticleUniverse::DoScaleEventHandler::setScaleFraction

(

const Real

scaleFraction

)

Set the scale fraction. This scale fraction value is used to scale different attributes if the event handler is called.

void ParticleUniverse::DoScaleEventHandler::setScaleType

(

const ScaleType &

scaleType

)

Set the scale type. This scale type identifies to which attribute the scale factor is applied.

Member Data Documentation

const Real ParticleUniverse::DoScaleEventHandler::DEFAULT_SCALE_FRACTION

static

const ScaleType ParticleUniverse::DoScaleEventHandler::DEFAULT_SCALE_TYPE

static

Real ParticleUniverse::DoScaleEventHandler::mScaleFraction

protected

ScaleType ParticleUniverse::DoScaleEventHandler::mScaleType

protected

---

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

• ParticleEventHandlers/ParticleUniverseDoScaleEventHandler.h