ParticleSystemOptions (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.scene.particle.options.ParticleSystemOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ParticleSystemOptions
extends Object

Options for ParticleSystem.

Author:: Serge Silaev aka iSergio

Field Summary

Fields
Modifier and Type	Field and Description
`ParticleBurst[]`	`bursts` An array of ParticleBurst, emitting bursts of particles at periodic times.
`Color`	`color` Sets the color of a particle for the duration of its particleLife.
`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.
`Cartesian2`	`imageSize` If set, overrides the minimumImageSize and maximumImageSize inputs that scale the particle image's dimensions in pixels.
`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.
`double`	`mass` Sets the minimum and maximum mass of particles in kilograms.
`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.
`double`	`particleLife` If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value.
`double`	`scale` Sets the scale to apply to the image of the particle for the duration of its particleLife.
`boolean`	`show` Whether to display the particle system.
`double`	`speed` Sets the minimum and maximum speed in meters per second
`Color`	`startColor` The color of a particle when it is born.
`double`	`startScale` The scale of the particle when it is born.
`ParticleSystem.UpdateCallback`	`updateCallback` The callback function to be called each frame to update a particle.

Constructor Summary

Constructors
Constructor and Description

ParticleSystemOptions()
Options for ParticleSystem.

Constructors
Constructor and Description
`ParticleSystemOptions()` Options for `ParticleSystem`.

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

- Field Detail
  - show
```
@JsProperty
public boolean show
```
    Whether to display the particle system. Default: true
  - updateCallback
```
@JsProperty
public ParticleSystem.UpdateCallback updateCallback
```
    The callback function to be called each frame to update a particle.
  - emitter
```
@JsProperty
public ParticleEmitter emitter
```
    The particle emitter for this system. Default: new CircleEmitter(0.5)
  - modelMatrix
```
@JsProperty
public Matrix4 modelMatrix
```
    The 4x4 transformation matrix that transforms the particle system from model to world coordinates. Default: Matrix4.IDENTITY().
  - 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().
  - color
```
@JsProperty
public Color color
```
    Sets the color of a particle for the duration of its particleLife. Default: Color.WHITE()
  - startColor
```
@JsProperty
public Color startColor
```
    The color of a particle when it is born.
  - endColor
```
@JsProperty
public Color endColor
```
    The color of a particle when it dies.
  - scale
```
@JsProperty
public double scale
```
    Sets the scale to apply to the image of the particle for the duration of its particleLife. Default: 1.0
  - startScale
```
@JsProperty
public double startScale
```
    The scale of the particle when it is born.
  - endScale
```
@JsProperty
public double endScale
```
    The scale of the particle when it dies.
  - emissionRate
```
@JsProperty
public double emissionRate
```
    The number of particles to emit per second. Default: 5
  - bursts
```
@JsProperty
public ParticleBurst[] bursts
```
    An array of ParticleBurst, emitting bursts of particles at periodic times.
  - loop
```
@JsProperty
public boolean loop
```
    Whether the particle system should loop it's bursts when it is complete. Default: true
  - speed
```
@JsProperty
public double speed
```
    Sets the minimum and maximum speed in meters per second
  - minimumSpeed
```
@JsProperty
public double minimumSpeed
```
    Sets the minimum speed in meters per second. Default: 1.0
  - maximumSpeed
```
@JsProperty
public double maximumSpeed
```
    Sets the maximum speed in meters per second. Default: 1.0
  - particleLife
```
@JsProperty
public double particleLife
```
    If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value. Default: 5.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.
  - 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.
  - mass
```
@JsProperty
public double mass
```
    Sets the minimum and maximum mass of particles in kilograms.
  - minimumMass
```
@JsProperty
public double minimumMass
```
    Sets the minimum mass of particles in kilograms. Default: 1.0
  - maximumMass
```
@JsProperty
public double maximumMass
```
    Sets the maximum mass of particles in kilograms. Default: 1.0
  - image
```
@JsProperty
public Object image
```
    The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.
  - imageSize
```
@JsProperty
public Cartesian2 imageSize
```
    If set, overrides the minimumImageSize and maximumImageSize inputs that scale the particle image's dimensions in pixels. Default: new Cartesian2(1.0, 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.
  - maximumImageSize
```
@JsProperty
public Cartesian2 maximumImageSize
```
    Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.
  - lifetime
```
@JsProperty
public double lifetime
```
    How long the particle system will emit particles, in seconds. Default: Double.MAX_VALUE
- Constructor Detail
  - ParticleSystemOptions
```
@JsConstructor
public ParticleSystemOptions()
```
    Options for ParticleSystem.

Class ParticleSystemOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

show

updateCallback

emitter

modelMatrix

emitterModelMatrix

color

startColor

endColor

scale

startScale

endScale

emissionRate

bursts

loop

speed

minimumSpeed

maximumSpeed

particleLife

minimumParticleLife

maximumParticleLife

mass

minimumMass

maximumMass

image

imageSize

minimumImageSize

maximumImageSize

lifetime

Constructor Detail

ParticleSystemOptions