Drag[en]gine Game Engine  1.0
deParticleEmitterController Class Reference

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. More...

#include <deParticleEmitterController.h>

Public Member Functions

Constructors and Destructors
 deParticleEmitterController ()
 
 ~deParticleEmitterController ()
 
Management
float GetLower () const
 
float GetUpper () const
 
void SetRange (float lower, float upper)
 
float GetValue () const
 
void SetValue (float value)
 
void Increment (float amount)
 
bool GetFrozen () const
 
void SetFrozen (bool frozen)
 
bool GetClamp () const
 
void SetClamp (bool clamp)
 

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::deParticleEmitterController ( )

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

◆ ~deParticleEmitterController()

deParticleEmitterController::~deParticleEmitterController ( )

Cleans up the controller.

Member Function Documentation

◆ GetClamp()

bool deParticleEmitterController::GetClamp ( ) const
inline

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

References decMath::clamp(), and SetClamp().

◆ GetFrozen()

bool deParticleEmitterController::GetFrozen ( ) const
inline

Determines if the controller is frozen.

References SetFrozen().

◆ GetLower()

float deParticleEmitterController::GetLower ( ) const
inline

Retrieves the lower value.

◆ GetUpper()

float deParticleEmitterController::GetUpper ( ) const
inline

Retrieves the upper value.

References SetRange().

◆ GetValue()

float deParticleEmitterController::GetValue ( ) const
inline

Retrieves the current value.

References Increment(), and SetValue().

◆ Increment()

void deParticleEmitterController::Increment ( float  amount)

Increments the value.

Referenced by GetValue().

◆ SetClamp()

void deParticleEmitterController::SetClamp ( bool  clamp)

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

Referenced by GetClamp().

◆ SetFrozen()

void deParticleEmitterController::SetFrozen ( bool  frozen)

Sets if the controller is frozen.

Referenced by GetFrozen().

◆ SetRange()

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

Sets the value range.

Referenced by GetUpper().

◆ SetValue()

void deParticleEmitterController::SetValue ( float  value)

Sets the current value.

Referenced by GetValue().


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