APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.graphics.g3d.particles.emitters

public abstract Class Emitter

extends ParticleControllerComponent
implements Serializable
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.utils.Json.Serializable
Known Direct Subclasses
com.badlogic.gdx.graphics.g3d.particles.emitters.RegularEmitter
Imports
com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent, com.badlogic.gdx.utils.Json, .JsonValue
An Emitter is a ParticleControllerComponent which will handle the particles emission. It must update the Emitter#percent to reflect the current percentage of the current emission cycle. It should consider Emitter#minParticleCount and Emitter#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

Modifier and TypeField and Description
public int
maxParticleCount

The min/max quantity of particles

public int
minParticleCount

The min/max quantity of particles

public float
percent

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

Inherited from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent:
controllerTMP_M3TMP_M4TMP_QTMP_Q2TMP_V1TMP_V2TMP_V3TMP_V4TMP_V5TMP_V6

Constructor Summary

AccessConstructor and Description
public
Emitter(Emitter regularEmitter)

public
Emitter()

Method Summary

Modifier and TypeMethod and Description
public void
end()

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

Called at the end of the simulation.

public int
getMaxParticleCount()

public int
getMinParticleCount()

public void
init()

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

Called once during intialization

public boolean
isComplete()

public void
read(Json json, JsonValue jsonData)

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

Implements com.badlogic.gdx.utils.Json.Serializable.read.

public void
set(Emitter emitter)

public void
setMaxParticleCount(int maxParticleCount)

public void
setMinParticleCount(int minParticleCount)

public void
setParticleCount(int aMin, int aMax)

public void
write(Json json)

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

Implements com.badlogic.gdx.utils.Json.Serializable.write.

Inherited from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent:
activateParticlesallocateChannelscopydisposekillParticlesloadsavesetstartupdate

Field Detail

maxParticleCountback to summary
public int maxParticleCount

The min/max quantity of particles

minParticleCountback to summary
public int minParticleCount

The min/max quantity of particles

percentback to summary
public float percent

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

Constructor Detail

Emitterback to summary
public Emitter(Emitter regularEmitter)
Emitterback to summary
public Emitter()

Method Detail

endback to summary
public void end()

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

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.end.

Called at the end of the simulation.

Annotations
@Override
getMaxParticleCountback to summary
public int getMaxParticleCount()
getMinParticleCountback to summary
public int getMinParticleCount()
initback to summary
public void init()

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

Doc from com.badlogic.gdx.graphics.g3d.particles.ParticleControllerComponent.init.

Called once during intialization

Annotations
@Override
isCompleteback to summary
public boolean isComplete()
readback to summary
public void read(Json json, JsonValue jsonData)

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

Implements com.badlogic.gdx.utils.Json.Serializable.read.

Annotations
@Override
setback to summary
public void set(Emitter emitter)
setMaxParticleCountback to summary
public void setMaxParticleCount(int maxParticleCount)
setMinParticleCountback to summary
public void setMinParticleCount(int minParticleCount)
setParticleCountback to summary
public void setParticleCount(int aMin, int aMax)
writeback to summary
public void write(Json json)

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

Implements com.badlogic.gdx.utils.Json.Serializable.write.

Annotations
@Override