Dragengine.Scenery.ParticleEmitterController Class Reference

ParticleEmitter or particle emitter instance controller. More...

Inheritance diagram for Dragengine.Scenery.ParticleEmitterController:

Public Member Functions
Management
ParticleEmitter	getParticleEmitter ()
	Owner particle emitter or null if not owned by particle emitter. More...
ParticleEmitterInstance	getParticleEmitterInstance ()
	Onwer particle emitter instance or null if not owned by particle emitter instance. More...
int	getControllerIndex ()
	Controller index. More...
Controllers
String	getName ()
	Name. More...
void	setName (String name)
	Set name. More...
float	getLower ()
	Lower limit. More...
float	getUpper ()
	Upper limit. More...
void	setRange (float lower, float upper)
	Set value range. More...
float	getValue ()
	Value. More...
void	setValue (float value)
	Set value. More...
float	getRelativeValue ()
	Value mapped from range (minimum..maximum) to range (0..1). More...
void	setRelativeValue (float value)
	Set value from range (0..1) mapped to range (minimum..maximum). More...
bool	getFrozen ()
	Controller is frozen. More...
void	setFrozen (bool frozen)
	Set if controller is frozen. More...
bool	getClamp ()
	Controller value is clamped instead of wrapped around if outside range. More...
void	setClamp (bool clamp)
	Set if controller value is clamped instead of wrapped around if outside range. More...
void	increment (float amount)
	Increment controller value. More...
void	setToLower ()
	Set controller value to lower value. More...
void	setToUpper ()
	Set controller value to upper value. More...
void	reverse ()
	Set controller value to maximum - currentValue. More...
void	setValueFrom (ParticleEmitterInstance instance)
	Set controller value and vector from another controller. More...
void	setAllFrom (ParticleEmitterInstance instance)
	Set entire controller configuration from another controller. More...
bool	isAtLower ()
	Controller value is at lower value. More...
bool	isAtUpper ()
	Controller value is at upper value. More...

Detailed Description

ParticleEmitter or particle emitter instance controller.

Wraps a particle emitter or particle emitter instance controller by controller index. Valid only as long as the wrapped particle emitter or particle emitter instance does not change controller layout.

If wrapping a particle emitter instance controller any changes to a controller triggers an update in the game engine.

If wrapping a particle emitter controller the user is responsible to call ParticleEmitter.contentChanged() after changing one or more controllers. ParticleEmitter controllers should not be changed if possible after being used in particle emitter instances.

This is a native class.

Member Function Documentation

getClamp()

bool Dragengine.Scenery.ParticleEmitterController.getClamp

(

)

Controller value is clamped instead of wrapped around if outside range.

getControllerIndex()

int Dragengine.Scenery.ParticleEmitterController.getControllerIndex

(

)

Controller index.

getFrozen()

bool Dragengine.Scenery.ParticleEmitterController.getFrozen

(

)

Controller is frozen.

getLower()

float Dragengine.Scenery.ParticleEmitterController.getLower

(

)

Lower limit.

getName()

String Dragengine.Scenery.ParticleEmitterController.getName

(

)

Name.

getParticleEmitter()

ParticleEmitter Dragengine.Scenery.ParticleEmitterController.getParticleEmitter

(

)

Owner particle emitter or null if not owned by particle emitter.

getParticleEmitterInstance()

ParticleEmitterInstance Dragengine.Scenery.ParticleEmitterController.getParticleEmitterInstance

(

)

Onwer particle emitter instance or null if not owned by particle emitter instance.

getRelativeValue()

float Dragengine.Scenery.ParticleEmitterController.getRelativeValue

(

)

Value mapped from range (minimum..maximum) to range (0..1).

getUpper()

float Dragengine.Scenery.ParticleEmitterController.getUpper

(

)

Upper limit.

getValue()

float Dragengine.Scenery.ParticleEmitterController.getValue

(

)

Value.

increment()

void Dragengine.Scenery.ParticleEmitterController.increment

(

float

amount

)

Increment controller value.

isAtLower()

bool Dragengine.Scenery.ParticleEmitterController.isAtLower

(

)

Controller value is at lower value.

isAtUpper()

bool Dragengine.Scenery.ParticleEmitterController.isAtUpper

(

)

Controller value is at upper value.

reverse()

void Dragengine.Scenery.ParticleEmitterController.reverse

(

)

Set controller value to maximum - currentValue.

setAllFrom()

void Dragengine.Scenery.ParticleEmitterController.setAllFrom

(

ParticleEmitterInstance

instance

)

Set entire controller configuration from another controller.

setClamp()

void Dragengine.Scenery.ParticleEmitterController.setClamp

(

bool

clamp

)

Set if controller value is clamped instead of wrapped around if outside range.

setFrozen()

void Dragengine.Scenery.ParticleEmitterController.setFrozen

(

bool

frozen

)

Set if controller is frozen.

setName()

void Dragengine.Scenery.ParticleEmitterController.setName

(

String

name

)

Set name.

setRange()

void Dragengine.Scenery.ParticleEmitterController.setRange	(	float	lower,
		float	upper
	)

Set value range.

setRelativeValue()

void Dragengine.Scenery.ParticleEmitterController.setRelativeValue

(

float

value

)

Set value from range (0..1) mapped to range (minimum..maximum).

setToLower()

void Dragengine.Scenery.ParticleEmitterController.setToLower

(

)

Set controller value to lower value.

setToUpper()

void Dragengine.Scenery.ParticleEmitterController.setToUpper

(

)

Set controller value to upper value.

setValue()

void Dragengine.Scenery.ParticleEmitterController.setValue

(

float

value

)

Set value.

setValueFrom()

void Dragengine.Scenery.ParticleEmitterController.setValueFrom

(

ParticleEmitterInstance

instance

)

Set controller value and vector from another controller.

---

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

• ParticleEmitterController.ds