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

Class Emitter

java.lang.Object

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

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

All Implemented Interfaces:

ResourceData.Configurable, Disposable, Json.Serializable

Direct Known Subclasses:

RegularEmitter

public abstract class Emitter
extends ParticleControllerComponent
implements Json.Serializable

An Emitter is a ParticleControllerComponent which will handle the particles emission. It must update the percent to reflect the current percentage of the current emission cycle. It should consider minParticleCount and maxParticleCount to rule particle emission. It should notify the particle controller when particles are activated, killed, or when an emission cycle begins.

Author:

Inferno

Field Summary

Fields

Modifier and Type	Field and Description
int	maxParticleCount The min/max quantity of particles
int	minParticleCount The min/max quantity of particles
float	percent Current state of the emission, should be currentTime/ duration Must be updated on each update

Constructor Summary

Constructors

Constructor and Description
Emitter()
Emitter(Emitter regularEmitter)

Method Summary

Methods

Modifier and Type	Method and Description
void	end() Called at the end of the simulation.
int	getMaxParticleCount()
int	getMinParticleCount()
void	init() Called once during intialization
void	read(Json json, JsonValue jsonData)
void	set(Emitter emitter)
void	setMaxParticleCount(int maxParticleCount)
void	setMinParticleCount(int minParticleCount)
void	setParticleCount(int aMin, int aMax)
void	write(Json json)

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

activateParticles, allocateChannels, copy, dispose, killParticles, load, save, set, start, update

Methods inherited from class java.lang.Object

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

Field Detail

minParticleCount

public int minParticleCount

The min/max quantity of particles

maxParticleCount

public int maxParticleCount

The min/max quantity of particles

percent

public float percent

Current state of the emission, should be currentTime/ duration Must be updated on each update

Constructor Detail

Emitter

public Emitter(Emitter regularEmitter)

Emitter

public Emitter()

Method Detail

init

public void init()

Description copied from class: ParticleControllerComponent

Called once during intialization

Overrides:

init in class ParticleControllerComponent

end

public void end()

Description copied from class: ParticleControllerComponent

Called at the end of the simulation.

Overrides:

end in class ParticleControllerComponent

getMinParticleCount

public int getMinParticleCount()

setMinParticleCount

public void setMinParticleCount(int minParticleCount)

getMaxParticleCount

public int getMaxParticleCount()

setMaxParticleCount

public void setMaxParticleCount(int maxParticleCount)

setParticleCount

public void setParticleCount(int aMin,
                    int aMax)

set

public void set(Emitter emitter)

write

public void write(Json json)

Specified by:

write in interface Json.Serializable

Overrides:

write in class ParticleControllerComponent

read

public void read(Json json,
        JsonValue jsonData)

Specified by:

read in interface Json.Serializable

Overrides:

read in class ParticleControllerComponent