com.badlogic.gdx.graphics.g3d.particles.emitters

Class RegularEmitter

java.lang.Object

com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent

com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter

com.badlogic.gdx.graphics.g3d.particles.emitters.RegularEmitter

All Implemented Interfaces:

ResourceData.Configurable, Disposable, Json.Serializable

public class RegularEmitter
extends Emitter
implements Json.Serializable

It's a generic use Emitter which fits most of the particles simulation scenarios.

Author:

Inferno

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegularEmitter.EmissionMode Possible emission modes.

Field Summary

Fields

Modifier and Type	Field and Description
RangedNumericValue	delayValue
RangedNumericValue	durationValue
ScaledNumericValue	emissionValue
ScaledNumericValue	lifeOffsetValue
ScaledNumericValue	lifeValue

Fields inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter

maxParticleCount, minParticleCount, percent

Constructor Summary

Constructors

Constructor and Description
RegularEmitter()
RegularEmitter(RegularEmitter regularEmitter)

Method Summary

Modifier and Type	Method and Description
void	activateParticles(int startIndex, int count) Called to initialize new emitted particles.
void	allocateChannels() Called during initialization to allocate additional particles channels
ParticleControllerComponent	copy()
RangedNumericValue	getDelay()
RangedNumericValue	getDuration()
ScaledNumericValue	getEmission()
RegularEmitter.EmissionMode	getEmissionMode() Gets current emission mode.
ScaledNumericValue	getLife()
ScaledNumericValue	getLifeOffset()
float	getPercentComplete()
void	init() Called once during intialization
boolean	isComplete()
boolean	isContinuous()
void	read(Json json, JsonValue jsonData)
void	set(RegularEmitter emitter)
void	setContinuous(boolean continuous)
void	setEmissionMode(RegularEmitter.EmissionMode emissionMode) Sets emission mode.
void	start() Called at the start of the simulation.
void	update() Called to execute the component behavior.
void	write(Json json)

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter

end, getMaxParticleCount, getMinParticleCount, set, setMaxParticleCount, setMinParticleCount, setParticleCount

Methods inherited from class com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent

dispose, killParticles, load, save, set

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

delayValue

public RangedNumericValue delayValue

durationValue

public RangedNumericValue durationValue

lifeOffsetValue

public ScaledNumericValue lifeOffsetValue

lifeValue

public ScaledNumericValue lifeValue

emissionValue

public ScaledNumericValue emissionValue

Constructor Detail

RegularEmitter

public RegularEmitter()

RegularEmitter

public RegularEmitter(RegularEmitter regularEmitter)

Method Detail

allocateChannels

public void allocateChannels()

Description copied from class: ParticleControllerComponent

Called during initialization to allocate additional particles channels

Overrides:

allocateChannels in class ParticleControllerComponent

start

public void start()

Description copied from class: ParticleControllerComponent

Called at the start of the simulation.

Overrides:

start in class ParticleControllerComponent

init

public void init()

Description copied from class: ParticleControllerComponent

Called once during intialization

Overrides:

init in class Emitter

activateParticles

public void activateParticles(int startIndex,
                              int count)

Description copied from class: ParticleControllerComponent

Called to initialize new emitted particles.

Overrides:

activateParticles in class ParticleControllerComponent

update

public void update()

Description copied from class: ParticleControllerComponent

Called to execute the component behavior.

Overrides:

update in class ParticleControllerComponent

getLife

public ScaledNumericValue getLife()

getEmission

public ScaledNumericValue getEmission()

getDuration

public RangedNumericValue getDuration()

getDelay

public RangedNumericValue getDelay()

getLifeOffset

public ScaledNumericValue getLifeOffset()

isContinuous

public boolean isContinuous()

setContinuous

public void setContinuous(boolean continuous)

getEmissionMode

public RegularEmitter.EmissionMode getEmissionMode()

Gets current emission mode.

Returns:

Current emission mode.

setEmissionMode

public void setEmissionMode(RegularEmitter.EmissionMode emissionMode)

Sets emission mode. Emission mode does not affect already emitted particles.

Parameters:

emissionMode - Emission mode to set.

isComplete

public boolean isComplete()

Overrides:

isComplete in class Emitter

getPercentComplete

public float getPercentComplete()

set

public void set(RegularEmitter emitter)

copy

public ParticleControllerComponent copy()

Specified by:

copy in class ParticleControllerComponent

write

public void write(Json json)

Specified by:

write in interface Json.Serializable

Overrides:

write in class Emitter

read

public void read(Json json,
                 JsonValue jsonData)

Specified by:

read in interface Json.Serializable

Overrides:

read in class Emitter