com.almasb.fxgl.effect

Class ParticleEmitter

java.lang.Object

com.almasb.fxgl.effect.ParticleEmitter

public class ParticleEmitter
extends Object

A general particle emitter. The configuration is done via setters, which allow changing how the particle is emitted and rendered.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ParticleEmitter()

Method Summary

Modifier and Type	Method and Description
Supplier<javafx.scene.paint.Paint>	getColorFunction()
Supplier<javafx.geometry.Point2D>	getGravityFunction()
int	getNumParticles()
protected double	getRandomSize()
double	getSizeMax()
double	getSizeMin()
protected double	rand() Returns a value in [0..1).
protected double	rand(double min, double max) Returns a value in [min..max).
void	setBlendFunction(TriFunction<Integer,Double,Double,javafx.scene.effect.BlendMode> blendFunction) Blend function is used to obtain blend mode for particles.
void	setColorFunction(Supplier<javafx.scene.paint.Paint> colorFunction) Set color function to particles created by this emitter.
void	setEmissionRate(double emissionRate) Set the emission rate.
void	setExpireFunction(TriFunction<Integer,Double,Double,javafx.util.Duration> expireFunction) Expire function is used to obtain expire time for particles.
void	setGravityFunction(Supplier<javafx.geometry.Point2D> gravityFunction) Set gravity function.
void	setNumParticles(int numParticles) Set number of particles being spawned per emission.
void	setScaleFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> scaleFunction) Scale function defines how the size of particles change over time.
void	setSize(double min, double max) Set size to particles.
void	setSourceImage(javafx.scene.image.Image sourceImage) Set source image for this emitter to produce particles.
void	setSpawnPointFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> spawnPointFunction) Particles will use the function to obtain spawn points.
void	setVelocityFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> velocityFunction) Set initial velocity function.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleEmitter

public ParticleEmitter()

Method Detail

getSizeMin

public final double getSizeMin()

Returns:

minimum particle size

getSizeMax

public final double getSizeMax()

Returns:

maximum particle size

getRandomSize

protected final double getRandomSize()

Returns:

random size between min and max size

setSize

public final void setSize(double min,
                          double max)

Set size to particles. The created size will be a random value between min (incl) and max (excl).

Parameters:

min - minimum size

max - maximum size

getColorFunction

public final Supplier<javafx.scene.paint.Paint> getColorFunction()

Returns:

particles color function

setColorFunction

public final void setColorFunction(Supplier<javafx.scene.paint.Paint> colorFunction)

Set color function to particles created by this emitter. The supplier function will be invoked every time a new particle is emitted.

Parameters:

colorFunction - particles color function.

getGravityFunction

public final Supplier<javafx.geometry.Point2D> getGravityFunction()

Returns:

gravity function

setGravityFunction

public final void setGravityFunction(Supplier<javafx.geometry.Point2D> gravityFunction)

Set gravity function. The supplier function is invoked every time when a new particle is spawned. Adds gravitational pull to particles. Once created the particle's movement will be biased towards the vector.

Parameters:

gravityFunction - gravity vector supplier function

Default Value:

(0, 0)

setVelocityFunction

public final void setVelocityFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> velocityFunction)

Set initial velocity function. Particles when spawned will use the function to obtain initial velocity.

Parameters:

velocityFunction - the velocity function

setSpawnPointFunction

public final void setSpawnPointFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> spawnPointFunction)

Particles will use the function to obtain spawn points.

Parameters:

spawnPointFunction - supplier of spawn points

setScaleFunction

public final void setScaleFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> scaleFunction)

Scale function defines how the size of particles change over time.

Parameters:

scaleFunction - scaling function

setExpireFunction

public final void setExpireFunction(TriFunction<Integer,Double,Double,javafx.util.Duration> expireFunction)

Expire function is used to obtain expire time for particles.

Parameters:

expireFunction - function to supply expire time

setBlendFunction

public final void setBlendFunction(TriFunction<Integer,Double,Double,javafx.scene.effect.BlendMode> blendFunction)

Blend function is used to obtain blend mode for particles.

Parameters:

blendFunction - blend supplier function

setSourceImage

public void setSourceImage(javafx.scene.image.Image sourceImage)

Set source image for this emitter to produce particles.

Parameters:

sourceImage - the image

Default Value:

null

getNumParticles

public final int getNumParticles()

Returns:

number of particles being spawned per emission

setNumParticles

public final void setNumParticles(int numParticles)

Set number of particles being spawned per emission.

Parameters:

numParticles - number of particles

setEmissionRate

public final void setEmissionRate(double emissionRate)

Set the emission rate. The value will be effectively clamped to [0..1].

1.0 - emission will occur every frame 0.5 - emission will occur every 2nd frame 0.33 - emission will occur every 3rd frame 0.0 - emission will never occur etc.

Parameters:

emissionRate - emission rate

rand

protected final double rand()

Returns a value in [0..1).

Returns:

random value between 0 (incl) and 1 (excl)

rand

protected final double rand(double min,
                            double max)

Returns a value in [min..max).

Parameters:

min - min bounds

max - max bounds

Returns:

a random value between min (incl) and max (excl)