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)

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<javafx.scene.effect.BlendMode>	blendMode
javafx.beans.property.DoubleProperty	emissionRate
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	endColor
javafx.beans.property.ObjectProperty<javafx.animation.Interpolator>	interpolator
javafx.beans.property.DoubleProperty	maxSize
javafx.beans.property.DoubleProperty	minSize
javafx.beans.property.IntegerProperty	numParticles
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	startColor

Constructor Summary

Constructors

Constructor and Description
ParticleEmitter()

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ObjectProperty<javafx.scene.effect.BlendMode>	blendModeProperty()
javafx.beans.property.DoubleProperty	emissionRateProperty()
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	endColorProperty()
Supplier<javafx.geometry.Point2D>	getAccelerationFunction()
javafx.scene.effect.BlendMode	getBlendMode() Gets the value of the property blendMode.
double	getEmissionRate()
javafx.scene.paint.Paint	getEndColor() Gets the value of the property endColor.
javafx.animation.Interpolator	getInterpolator() Gets the value of the property interpolator.
int	getMaxEmissions()
double	getMaxSize()
double	getMinSize()
int	getNumParticles()
javafx.scene.paint.Paint	getStartColor() Gets the value of the property startColor.
javafx.beans.property.ObjectProperty<javafx.animation.Interpolator>	interpolatorProperty()
boolean	isFinished()
javafx.beans.property.DoubleProperty	maxSizeProperty()
javafx.beans.property.DoubleProperty	minSizeProperty()
javafx.beans.property.IntegerProperty	numParticlesProperty()
protected double	rand() Returns a value in [0..1).
protected double	rand(double min, double max) Returns a value in [min..max).
void	setAccelerationFunction(Supplier<javafx.geometry.Point2D> gravityFunction) Set gravity function.
void	setBlendMode(javafx.scene.effect.BlendMode blendMode) Sets the value of the property blendMode.
void	setColor(javafx.scene.paint.Paint color)
void	setEmissionRate(double emissionRate) Set the emission rate.
void	setEndColor(javafx.scene.paint.Paint endColor) Sets the value of the property endColor.
void	setExpireFunction(TriFunction<Integer,Double,Double,javafx.util.Duration> expireFunction) Expire function is used to obtain expire time for particles.
void	setInterpolator(javafx.animation.Interpolator interpolator) Sets the value of the property interpolator.
void	setMaxEmissions(int maxEmissions)
void	setMaxSize(double maxSize) Sets the value of the property maxSize.
void	setMinSize(double minSize) Sets the value of the property minSize.
void	setNumParticles(int numParticles)
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	setStartColor(javafx.scene.paint.Paint startColor) Sets the value of the property startColor.
void	setVelocityFunction(TriFunction<Integer,Double,Double,javafx.geometry.Point2D> velocityFunction) Set initial velocity function.
javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint>	startColorProperty()

Methods inherited from class java.lang.Object

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

Property Detail

numParticles

public javafx.beans.property.IntegerProperty numParticlesProperty

See Also:

getNumParticles(), setNumParticles(int)

emissionRate

public final javafx.beans.property.DoubleProperty emissionRateProperty

See Also:

getEmissionRate(), setEmissionRate(double)

minSize

public final javafx.beans.property.DoubleProperty minSizeProperty

See Also:

getMinSize(), setMinSize(double)

maxSize

public final javafx.beans.property.DoubleProperty maxSizeProperty

See Also:

getMaxSize(), setMaxSize(double)

startColor

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> startColorProperty

See Also:

getStartColor(), setStartColor(Paint)

endColor

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> endColorProperty

See Also:

getEndColor(), setEndColor(Paint)

blendMode

public final javafx.beans.property.ObjectProperty<javafx.scene.effect.BlendMode> blendModeProperty

See Also:

getBlendMode(), setBlendMode(BlendMode)

interpolator

public final javafx.beans.property.ObjectProperty<javafx.animation.Interpolator> interpolatorProperty

See Also:

getInterpolator(), setInterpolator(Interpolator)

Constructor Detail

ParticleEmitter

public ParticleEmitter()

Method Detail

numParticlesProperty

public javafx.beans.property.IntegerProperty numParticlesProperty()

See Also:

getNumParticles(), setNumParticles(int)

getNumParticles

public final int getNumParticles()

Returns:

number of particles being spawned per emission

setNumParticles

public final void setNumParticles(int numParticles)

Parameters:

numParticles - number of particles being spawned per emission

emissionRateProperty

public final javafx.beans.property.DoubleProperty emissionRateProperty()

See Also:

getEmissionRate(), setEmissionRate(double)

getEmissionRate

public final double getEmissionRate()

Returns:

emission rate effective value in [0..1]

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

getMaxEmissions

public final int getMaxEmissions()

setMaxEmissions

public final void setMaxEmissions(int maxEmissions)

isFinished

public boolean isFinished()

getMinSize

public final double getMinSize()

Returns:

minimum particle size

minSizeProperty

public final javafx.beans.property.DoubleProperty minSizeProperty()

See Also:

getMinSize(), setMinSize(double)

setMinSize

public final void setMinSize(double minSize)

Sets the value of the property minSize.

getMaxSize

public final double getMaxSize()

Returns:

maximum particle size

maxSizeProperty

public final javafx.beans.property.DoubleProperty maxSizeProperty()

See Also:

getMaxSize(), setMaxSize(double)

setMaxSize

public final void setMaxSize(double maxSize)

Sets the value of the property maxSize.

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

getStartColor

public final javafx.scene.paint.Paint getStartColor()

Gets the value of the property startColor.

startColorProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> startColorProperty()

See Also:

getStartColor(), setStartColor(Paint)

setStartColor

public final void setStartColor(javafx.scene.paint.Paint startColor)

Sets the value of the property startColor.

getEndColor

public final javafx.scene.paint.Paint getEndColor()

Gets the value of the property endColor.

endColorProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.paint.Paint> endColorProperty()

See Also:

getEndColor(), setEndColor(Paint)

setEndColor

public final void setEndColor(javafx.scene.paint.Paint endColor)

Sets the value of the property endColor.

setColor

public final void setColor(javafx.scene.paint.Paint color)

getBlendMode

public final javafx.scene.effect.BlendMode getBlendMode()

Gets the value of the property blendMode.

blendModeProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.effect.BlendMode> blendModeProperty()

See Also:

getBlendMode(), setBlendMode(BlendMode)

setBlendMode

public final void setBlendMode(javafx.scene.effect.BlendMode blendMode)

Sets the value of the property blendMode.

getInterpolator

public final javafx.animation.Interpolator getInterpolator()

Gets the value of the property interpolator.

interpolatorProperty

public final javafx.beans.property.ObjectProperty<javafx.animation.Interpolator> interpolatorProperty()

See Also:

getInterpolator(), setInterpolator(Interpolator)

setInterpolator

public final void setInterpolator(javafx.animation.Interpolator interpolator)

Sets the value of the property interpolator.

getAccelerationFunction

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

Returns:

gravity function

setAccelerationFunction

public final void setAccelerationFunction(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

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

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)