deParticleEmitterController Class Reference

Particle Emitter Class. More...

#include <deParticleEmitterController.h>

List of all members.

Public Member Functions
Constructors and Destructors
	deParticleEmitterController ()
	Creates a new controller with range 0 to 1 and the value 0.
	~deParticleEmitterController ()
	Cleans up the controller.
Management
float	GetLower () const
	Retrieves the lower value.
float	GetUpper () const
	Retrieves the upper value.
void	SetRange (float lower, float upper)
	Sets the value range.
float	GetValue () const
	Retrieves the current value.
void	SetValue (float value)
	Sets the current value.
void	Increment (float amount)
	Increments the value.
bool	GetFrozen () const
	Determines if the controller is frozen.
void	SetFrozen (bool frozen)
	Sets if the controller is frozen.
bool	GetClamp () const
	Determines if values passed the range are clamped or wrapped around.
void	SetClamp (bool clamp)
	Sets if values passed the range are clamped or wrapped around.

---

Detailed Description

Particle Emitter Class.

Particle emitter controllers provide the user with control over how the individual particles are cast. Controllers are written in a way that you can use them without having to do scaling or transformation on your own. You can provide a minimum and maximum value matching your setup. The controller takes care of transforming the current value into the proper 0 to 1 range required by the cast curves in parameters. The current value is set by the user and is clamped to the range specified before. The real value is in the range 0 to 1 and is used by the cast curves. The real value can only be read. Furthermore a controller can be frozen. If a controller is frozen the current value can be changed. This is useful to prevent a controller from changing without having to change all code path to account for the frozen state.

Author:

Plüss Roland

Version:

1.0

Date:

2010

---

Constructor & Destructor Documentation

deParticleEmitterController::deParticleEmitterController

(

)

Creates a new controller with range 0 to 1 and the value 0.

deParticleEmitterController::~deParticleEmitterController

(

)

Cleans up the controller.

---

Member Function Documentation

bool deParticleEmitterController::GetClamp

(

)

const [inline]

Determines if values passed the range are clamped or wrapped around.

bool deParticleEmitterController::GetFrozen

(

)

const [inline]

Determines if the controller is frozen.

float deParticleEmitterController::GetLower

(

)

const [inline]

Retrieves the lower value.

float deParticleEmitterController::GetUpper

(

)

const [inline]

Retrieves the upper value.

float deParticleEmitterController::GetValue

(

)

const [inline]

Retrieves the current value.

void deParticleEmitterController::Increment

(

float

amount )

Increments the value.

void deParticleEmitterController::SetClamp

(

bool

clamp )

Sets if values passed the range are clamped or wrapped around.

void deParticleEmitterController::SetFrozen

(

bool

frozen )

Sets if the controller is frozen.

void deParticleEmitterController::SetRange	(	float	lower,
		float	upper
	)

Sets the value range.

void deParticleEmitterController::SetValue

(

float

value )

Sets the current value.

---

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

• deParticleEmitterController.h