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

public abstract Class ParticleControllerComponent

extends Object
implements Disposable, Serializable, Configurable
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable, com.badlogic.gdx.utils.Json.Serializable, com.badlogic.gdx.utils.Disposable
Known Direct Subclasses
com.badlogic.gdx.graphics.g3d.particles.emitters.Emitter, com.badlogic.gdx.graphics.g3d.particles.influencers.Influencer, com.badlogic.gdx.graphics.g3d.particles.renderers.ParticleControllerRenderer
Imports
com.badlogic.gdx.assets.AssetManager, com.badlogic.gdx.math.Matrix3, .Matrix4, .Quaternion, .Vector3, com.badlogic.gdx.utils.Disposable, .Json, .JsonValue
It's the base class of every ParticleController component. A component duty is to participate in one or some events during the simulation. (i.e it can handle the particles emission or modify particle properties, etc.).
Author
inferno

Field Summary

Modifier and TypeField and Description
protected ParticleController
controller

protected static final Matrix3
TMP_M3

protected static final Matrix4
TMP_M4

protected static final Quaternion
TMP_Q

protected static final Quaternion
TMP_Q2

protected static final Vector3
TMP_V1

protected static final Vector3
TMP_V2

protected static final Vector3
TMP_V3

protected static final Vector3
TMP_V4

protected static final Vector3
TMP_V5

protected static final Vector3
TMP_V6

Constructor Summary

AccessConstructor and Description
public
ParticleControllerComponent()

Method Summary

Modifier and TypeMethod and Description
public void
activateParticles(int startIndex, int count)

Called to initialize new emitted particles.

public void
allocateChannels()

Called during initialization to allocate additional particles channels

public abstract ParticleControllerComponent
copy()

public void
dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

public void
end()

Called at the end of the simulation.

public void
init()

Called once during intialization

public void
killParticles(int startIndex, int count)

Called to notify which particles have been killed.

public void
load(AssetManager manager, ResourceData<T> data)

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.

public void
read(Json json, JsonValue jsonData)

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

public void
save(AssetManager manager, ResourceData<T> data)

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.

public void
set(ParticleController particleController)

public void
start()

Called at the start of the simulation.

public void
update()

Called to execute the component behavior.

public void
write(Json json)

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

controllerback to summary
protected ParticleController controller
TMP_M3back to summary
protected static final Matrix3 TMP_M3
TMP_M4back to summary
protected static final Matrix4 TMP_M4
TMP_Qback to summary
protected static final Quaternion TMP_Q
TMP_Q2back to summary
protected static final Quaternion TMP_Q2
TMP_V1back to summary
protected static final Vector3 TMP_V1
TMP_V2back to summary
protected static final Vector3 TMP_V2
TMP_V3back to summary
protected static final Vector3 TMP_V3
TMP_V4back to summary
protected static final Vector3 TMP_V4
TMP_V5back to summary
protected static final Vector3 TMP_V5
TMP_V6back to summary
protected static final Vector3 TMP_V6

Constructor Detail

ParticleControllerComponentback to summary
public ParticleControllerComponent()

Method Detail

activateParticlesback to summary
public void activateParticles(int startIndex, int count)

Called to initialize new emitted particles.

allocateChannelsback to summary
public void allocateChannels()

Called during initialization to allocate additional particles channels

copyback to summary
public abstract ParticleControllerComponent copy()
disposeback to summary
public void dispose()

Implements com.badlogic.gdx.utils.Disposable.dispose.

Doc from com.badlogic.gdx.utils.Disposable.dispose.

Releases all resources of this object.

endback to summary
public void end()

Called at the end of the simulation.

initback to summary
public void init()

Called once during intialization

killParticlesback to summary
public void killParticles(int startIndex, int count)

Called to notify which particles have been killed.

loadback to summary
public void load(AssetManager manager, ResourceData<T> data)

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.load.

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

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

Annotations
@Override
saveback to summary
public void save(AssetManager manager, ResourceData<T> data)

Implements com.badlogic.gdx.graphics.g3d.particles.ResourceData.Configurable.save.

Annotations
@Override
setback to summary
public void set(ParticleController particleController)
startback to summary
public void start()

Called at the start of the simulation.

updateback to summary
public void update()

Called to execute the component behavior.

writeback to summary
public void write(Json json)

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

Annotations
@Override