com.almasb.fxgl.effect

Class ParticleControl

java.lang.Object

com.almasb.fxgl.ecs.AbstractControl

com.almasb.fxgl.effect.ParticleControl

All Implemented Interfaces:

Control

public class ParticleControl
extends AbstractControl

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) Called when this control is removed from entity.
void	onUpdate(Entity entity, double tpf) Called on entity world update tick.
void	renderParticles(javafx.scene.canvas.GraphicsContext g, javafx.geometry.Point2D viewportOrigin) Do NOT call manually.

Methods inherited from class com.almasb.fxgl.ecs.AbstractControl

getEntity, isPaused, onAdded, pause, resume

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)

Description copied from interface: Control

Called on entity world update tick.

Parameters:

entity - the entity to which this control is attached

tpf - time per frame

onRemoved

public void onRemoved(Entity entity)

Description copied from interface: Control

Called when this control is removed from entity. This is called after any control related listeners are notified. This allows the control to clean up properly.

Specified by:

onRemoved in interface Control

Overrides:

onRemoved in class AbstractControl

Parameters:

entity - the entity from which the control was removed

renderParticles

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

Do NOT call manually.

Parameters:

g - graphics context

viewportOrigin - viewport origin

getEmitter

public ParticleEmitter getEmitter()

Returns:

particle emitter attached to control