ParticleEmitter (fxgl 0.3.4 API)

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()

Constructors
Constructor and Description
`ParticleEmitter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javafx.scene.effect.BlendMode`	`getBlendMode()`
`javafx.scene.paint.Paint`	`getColor()`
`javafx.scene.paint.Paint`	`getEndColor()`
`Supplier<javafx.geometry.Point2D>`	`getGravityFunction()`
`int`	`getNumParticles()`
`protected double`	`getRandomSize()`
`double`	`getSizeMax()`
`double`	`getSizeMin()`
`javafx.scene.paint.Paint`	`getStartColor()`
`protected double`	`rand()` Returns a value in [0..1).
`protected double`	`rand(double min, double max)` Returns a value in [min..max).
`void`	`setBlendMode(javafx.scene.effect.BlendMode blendMode)` Blend function is used to obtain blend mode for particles.
`void`	`setColor(javafx.scene.paint.Paint startColor)`
`void`	`setEmissionRate(double emissionRate)` Set the emission rate.
`void`	`setEndColor(javafx.scene.paint.Paint endColor)`
`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`	`setStartColor(javafx.scene.paint.Paint startColor)`
`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
  - getStartColor
```
public javafx.scene.paint.Paint getStartColor()
```
  - setStartColor
```
public void setStartColor(javafx.scene.paint.Paint startColor)
```
  - getEndColor
```
public javafx.scene.paint.Paint getEndColor()
```
  - setEndColor
```
public void setEndColor(javafx.scene.paint.Paint endColor)
```
  - getColor
```
public javafx.scene.paint.Paint getColor()
```
  - setColor
```
public void setColor(javafx.scene.paint.Paint startColor)
```
  - 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
  - getBlendMode
```
public javafx.scene.effect.BlendMode getBlendMode()
```
  - setBlendMode
```
public void setBlendMode(javafx.scene.effect.BlendMode blendMode)
```
    Blend function is used to obtain blend mode for particles.
    
    Parameters:
    
    blendMode - 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

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)

Class ParticleEmitter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticleEmitter

Method Detail

getSizeMin

getSizeMax

getRandomSize

setSize

getStartColor

setStartColor

getEndColor

setEndColor

getColor

setColor

getGravityFunction

setGravityFunction

setVelocityFunction

setSpawnPointFunction

setScaleFunction

setExpireFunction

getBlendMode

setBlendMode

setSourceImage

getNumParticles

setNumParticles

setEmissionRate

rand

rand