Package com.badlogic.gdx.graphics.g3d.particles

Class ParticleEffect

java.lang.Object

com.badlogic.gdx.graphics.g3d.particles.ParticleEffect

All Implemented Interfaces:

ResourceData.Configurable, Disposable

public class ParticleEffect
extends java.lang.Object
implements Disposable, ResourceData.Configurable

It's a set of particles controllers. It can be updated, rendered, transformed which means the changes will be applied on all the particles controllers.

Constructor Summary

Constructors

Constructor	Description
ParticleEffect()
ParticleEffect(ParticleController... emitters)
ParticleEffect(ParticleEffect effect)

Method Summary

Modifier and Type	Method	Description
ParticleEffect	copy()
void	dispose()	Releases all resources of this object.
void	draw()
void	end()
ParticleController	findController(java.lang.String name)	Returns the controller with the specified name, or null.
BoundingBox	getBoundingBox()
Array<ParticleController>	getControllers()
void	init()
boolean	isComplete()
void	load(AssetManager assetManager, ResourceData data)	Loads all the assets required by all the controllers inside this effect.
void	reset()
void	rotate(Quaternion rotation)	Applies the rotation to the current transformation matrix of each controller.
void	rotate(Vector3 axis, float angle)	Applies the rotation by the given angle around the given axis to the current transformation matrix of each controller.
void	save(AssetManager assetManager, ResourceData data)	Saves all the assets required by all the controllers inside this effect.
void	scale(float scaleX, float scaleY, float scaleZ)	Applies the scale to the current transformation matrix of each controller.
void	scale(Vector3 scale)	Applies the scale to the current transformation matrix of each controller.
void	setBatch(Array<ParticleBatch<?>> batches)	Assign one batch, among those passed in, to each controller.
void	setTransform(Matrix4 transform)	Sets the given transform matrix on each controller.
void	start()
void	translate(Vector3 translation)	Applies the translation to the current transformation matrix of each controller.
void	update()
void	update(float deltaTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleEffect

public ParticleEffect()

ParticleEffect

public ParticleEffect(ParticleEffect effect)

ParticleEffect

public ParticleEffect(ParticleController... emitters)

Method Detail

init

public void init()

start

public void start()

end

public void end()

reset

public void reset()

update

public void update()

update

public void update(float deltaTime)

draw

public void draw()

isComplete

public boolean isComplete()

setTransform

public void setTransform(Matrix4 transform)

Sets the given transform matrix on each controller.

rotate

public void rotate(Quaternion rotation)

Applies the rotation to the current transformation matrix of each controller.

rotate

public void rotate(Vector3 axis,
                   float angle)

Applies the rotation by the given angle around the given axis to the current transformation matrix of each controller.

Parameters:

axis - the rotation axis

angle - the rotation angle in degrees

translate

public void translate(Vector3 translation)

Applies the translation to the current transformation matrix of each controller.

scale

public void scale(float scaleX,
                  float scaleY,
                  float scaleZ)

Applies the scale to the current transformation matrix of each controller.

scale

public void scale(Vector3 scale)

Applies the scale to the current transformation matrix of each controller.

getControllers

public Array<ParticleController> getControllers()

Returns:

all particle controllers.

findController

public ParticleController findController(java.lang.String name)

Returns the controller with the specified name, or null.

dispose

public void dispose()

Description copied from interface: Disposable

Releases all resources of this object.

Specified by:

dispose in interface Disposable

getBoundingBox

public BoundingBox getBoundingBox()

Returns:

the merged bounding box of all controllers.

setBatch

public void setBatch(Array<ParticleBatch<?>> batches)

Assign one batch, among those passed in, to each controller. The batch must be compatible with the controller to be assigned.

copy

public ParticleEffect copy()

Returns:

a copy of this effect, should be used after the particle effect has been loaded.

save

public void save(AssetManager assetManager,
                 ResourceData data)

Saves all the assets required by all the controllers inside this effect.

Specified by:

save in interface ResourceData.Configurable

load

public void load(AssetManager assetManager,
                 ResourceData data)

Loads all the assets required by all the controllers inside this effect.

Specified by:

load in interface ResourceData.Configurable