com.almasb.fxgl.effect

Class ParticleControl

java.lang.Object

com.almasb.fxgl.entity.Module

com.almasb.fxgl.entity.Control

com.almasb.fxgl.effect.ParticleControl

public class ParticleControl
extends Control

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected Array<Particle>	particles

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParticleControl()
	ParticleControl(ParticleEmitter emitter) Constructs particle control with specified emitter.

Method Summary

Modifier and Type	Method and Description
ParticleEmitter	getEmitter()
void	onRemoved(Entity entity)
void	onUpdate(Entity entity, double tpf)
void	renderParticles(javafx.scene.canvas.GraphicsContext g, javafx.geometry.Point2D viewportOrigin) Do NOT call manually.
void	setOnFinished(Runnable onFinished)

Methods inherited from class com.almasb.fxgl.entity.Control

isPaused, pause, resume

Methods inherited from class com.almasb.fxgl.entity.Module

getEntity, onAdded

Methods inherited from class java.lang.Object

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

Field Detail

particles

protected Array<Particle> particles

Constructor Detail

ParticleControl

public ParticleControl(ParticleEmitter emitter)

Constructs particle control with specified emitter.

Parameters:

emitter - particle emitter

ParticleControl

protected ParticleControl()

Method Detail

onUpdate

public void onUpdate(Entity entity,
                     double tpf)

Specified by:

onUpdate in class Control

onRemoved

public void onRemoved(Entity entity)

Overrides:

onRemoved in class Module

renderParticles

public final void renderParticles(javafx.scene.canvas.GraphicsContext g,
                                  javafx.geometry.Point2D viewportOrigin)

Do NOT call manually.

Parameters:

g - graphics context

viewportOrigin - viewport origin

getEmitter

public final ParticleEmitter getEmitter()

Returns:

particle emitter attached to control

setOnFinished

public final void setOnFinished(Runnable onFinished)