com.badlogic.gdx.graphics.g3d.particles

Class ParticleSystem

java.lang.Object

com.badlogic.gdx.graphics.g3d.particles.ParticleSystem

All Implemented Interfaces:

RenderableProvider

public final class ParticleSystem
extends Object
implements RenderableProvider

Singleton class which manages the particle effects. It's a utility class to ease particle batches management and particle effects update.

Author:

inferno

Constructor Summary

Constructors

Constructor and Description
ParticleSystem()

Method Summary

Modifier and Type	Method and Description
void	add(ParticleBatch<?> batch)
void	add(ParticleEffect effect)
void	begin() Must be called one time per frame before any particle effect drawing operation will occur.
void	draw() Draws all the particle effects.
void	end() Must be called one time per frame at the end of all drawing operations.
static ParticleSystem	get() Deprecated. Please directly use the constructor
Array<ParticleBatch<?>>	getBatches()
void	getRenderables(Array<Renderable> renderables, Pool<Renderable> pool) Returns Renderable instances.
void	remove(ParticleEffect effect)
void	removeAll() Removes all the effects added to the system
void	update() Updates the simulation of all effects
void	updateAndDraw()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleSystem

public ParticleSystem()

Method Detail

get

public static ParticleSystem get()

Deprecated. Please directly use the constructor

add

public void add(ParticleBatch<?> batch)

add

public void add(ParticleEffect effect)

remove

public void remove(ParticleEffect effect)

removeAll

public void removeAll()

Removes all the effects added to the system

update

public void update()

Updates the simulation of all effects

updateAndDraw

public void updateAndDraw()

begin

public void begin()

Must be called one time per frame before any particle effect drawing operation will occur.

draw

public void draw()

Draws all the particle effects. Call begin() before this method and end() after.

end

public void end()

Must be called one time per frame at the end of all drawing operations.

getRenderables

public void getRenderables(Array<Renderable> renderables,
                           Pool<Renderable> pool)

Description copied from interface: RenderableProvider

Returns Renderable instances. Renderables are obtained from the provided Pool and added to the provided array. The Renderables obtained using Pool.obtain() will later be put back into the pool, do not store them internally. The resulting array can be rendered via a ModelBatch.

Specified by:

getRenderables in interface RenderableProvider

Parameters:

renderables - the output array

pool - the pool to obtain Renderables from

getBatches

public Array<ParticleBatch<?>> getBatches()