ParticleSystem (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.particle.ParticleSystem

@JsType(isNative=true,
        namespace="Cesium",
        name="ParticleSystem")
public class ParticleSystem
extends Object

A ParticleSystem manages the updating and display of a collection of particles.

Author:: Serge Silaev aka iSergio

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ParticleSystem.UpdateCallback

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ParticleSystem.UpdateCallback`

Field Summary

Fields
Modifier and Type	Field and Description
`Event`	`complete` Fires an event when the particle system has reached the end of its lifetime.
`double`	`emissionRate` The number of particles to emit per second.
`ParticleEmitter`	`emitter` The particle emitter for this system.
`Matrix4`	`emitterModelMatrix` The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system.
`Color`	`endColor` The color of a particle when it dies.
`double`	`endScale` The scale of the particle when it dies.
`Object`	`image` The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
`boolean`	`isComplete` When true, the particle system has reached the end of its lifetime; false otherwise.
`double`	`lifetime` How long the particle system will emit particles, in seconds.
`boolean`	`loop` Whether the particle system should loop it's bursts when it is complete.
`Cartesian2`	`maximumImageSize` Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.
`double`	`maximumMass` Sets the maximum mass of particles in kilograms.
`double`	`maximumParticleLife` Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen.
`double`	`maximumSpeed` Sets the maximum speed in meters per second.
`Cartesian2`	`minimumImageSize` Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels.
`double`	`minimumMass` Sets the minimum mass of particles in kilograms.
`double`	`minimumParticleLife` Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen.
`double`	`minimumSpeed` Sets the minimum speed in meters per second.
`Matrix4`	`modelMatrix` The 4x4 transformation matrix that transforms the particle system from model to world coordinates.
`boolean`	`show` Whether to display the particle system.
`Color`	`startColor` The color of a particle when it is born.
`double`	`startScale` The scale of the particle when it is born.

Constructor Summary

Constructors
Constructor and Description
`ParticleSystem()` A ParticleSystem manages the updating and display of a collection of particles.
`ParticleSystem(ParticleSystemOptions options)` A ParticleSystem manages the updating and display of a collection of particles.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Destroys the WebGL resources held by this object.
`boolean`	`isDestroyed()` Returns true if this object was destroyed; otherwise, false.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - complete
```
@JsProperty
public Event complete
```
    Fires an event when the particle system has reached the end of its lifetime.
  - emitter
```
@JsProperty
public ParticleEmitter emitter
```
    The particle emitter for this system. Default: new CircleEmitter(0.5)
  - emitterModelMatrix
```
@JsProperty
public Matrix4 emitterModelMatrix
```
    The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system. Default: Matrix4.IDENTITY().
  - endColor
```
@JsProperty
public Color endColor
```
    The color of a particle when it dies. Default: Color.WHITE().
  - endScale
```
@JsProperty
public double endScale
```
    The scale of the particle when it dies. Default: 1.0
  - image
```
@JsProperty
public Object image
```
    The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
  - isComplete
```
@JsProperty
public boolean isComplete
```
    When true, the particle system has reached the end of its lifetime; false otherwise.
  - lifetime
```
@JsProperty
public double lifetime
```
    How long the particle system will emit particles, in seconds. Default: Double.MAX_VALUE
  - loop
```
@JsProperty
public boolean loop
```
    Whether the particle system should loop it's bursts when it is complete. Default: true
  - maximumImageSize
```
@JsProperty
public Cartesian2 maximumImageSize
```
    Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.
  - maximumMass
```
@JsProperty
public double maximumMass
```
    Sets the maximum mass of particles in kilograms. Default: 1.0
  - maximumParticleLife
```
@JsProperty
public double maximumParticleLife
```
    Sets the maximum bound in seconds for the possible duration of a particle's life below which a particle's actual life will be randomly chosen.
  - maximumSpeed
```
@JsProperty
public double maximumSpeed
```
    Sets the maximum speed in meters per second. Default: 1.0
  - minimumImageSize
```
@JsProperty
public Cartesian2 minimumImageSize
```
    Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels.
  - minimumMass
```
@JsProperty
public double minimumMass
```
    Sets the minimum mass of particles in kilograms. Default: 1.0
  - minimumParticleLife
```
@JsProperty
public double minimumParticleLife
```
    Sets the minimum bound in seconds for the possible duration of a particle's life above which a particle's actual life will be randomly chosen.
  - minimumSpeed
```
@JsProperty
public double minimumSpeed
```
    Sets the minimum speed in meters per second. Default: 1.0
  - modelMatrix
```
@JsProperty
public Matrix4 modelMatrix
```
    The 4x4 transformation matrix that transforms the particle system from model to world coordinates. Default: Matrix4.IDENTITY().
  - emissionRate
```
@JsProperty
public double emissionRate
```
    The number of particles to emit per second. Default: 5
  - show
```
@JsProperty
public boolean show
```
    Whether to display the particle system. Default: true
  - startColor
```
@JsProperty
public Color startColor
```
    The color of a particle when it is born. Default: Color.WHITE().
  - startScale
```
@JsProperty
public double startScale
```
    The scale of the particle when it is born. Default: 1.0
- Constructor Detail
  - ParticleSystem
```
@JsConstructor
public ParticleSystem()
```
    A ParticleSystem manages the updating and display of a collection of particles.
  - ParticleSystem
```
@JsConstructor
public ParticleSystem(ParticleSystemOptions options)
```
    A ParticleSystem manages the updating and display of a collection of particles.
    
    Parameters:
    
    options - ParticleSystemOptions.
- Method Detail
  - destroy
```
@JsMethod
public void destroy()
```
    Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
    
    See Also:
    
    isDestroyed()
  - isDestroyed
```
@JsMethod
public boolean isDestroyed()
```
    Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
    
    Returns:
    
    true if this object was destroyed; otherwise, false.

Class ParticleSystem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

complete

emitter

emitterModelMatrix

endColor

endScale

image

isComplete

lifetime

loop

maximumImageSize

maximumMass

maximumParticleLife

maximumSpeed

minimumImageSize

minimumMass

minimumParticleLife

minimumSpeed

modelMatrix

emissionRate

show

startColor

startScale

Constructor Detail

ParticleSystem

ParticleSystem

Method Detail

destroy

isDestroyed