kotlin-cesium-engine/cesium.engine/ParticleSystem

ParticleSystem

external class ParticleSystem(options: ParticleSystem.ConstructorOptions? = definedExternally)(source)

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

See also

Online Documentation

Constructors

constructor(options: ParticleSystem.ConstructorOptions? = definedExternally)

Types

ConstructorOptions

sealed interface ConstructorOptions

Properties

var bursts: ReadonlyArray<ParticleBurst>

An array of ParticleBurst, emitting bursts of particles at periodic times.

var complete: DefaultEvent

Fires an event when the particle system has reached the end of its lifetime.

var emissionRate: Int

The number of particles to emit per second.

var emitter: ParticleEmitter

The particle emitter for this

emitterModelMatrix

var emitterModelMatrix: Matrix4

The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system.

var endColor: Color

The color of the particle at the end of its life.

var endScale: Double

The final scale to apply to the image of the particle at the end of its life.

The URI, HTMLImageElement, or HTMLCanvasElement to use for the billboard.

var isComplete: Boolean

When true, the particle system has reached the end of its lifetime; false otherwise.

var lifetime: Double

How long the particle system will emit particles, in seconds.

var loop: Boolean

Whether the particle system should loop it's bursts when it is complete.

maximumImageSize

var maximumImageSize: Cartesian2

Sets the maximum bound, width by height, below which to randomly scale the particle image's dimensions in pixels.

var maximumMass: Double

Sets the maximum mass of particles in kilograms.

maximumParticleLife

var maximumParticleLife: Double

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.

var maximumSpeed: Double

Sets the maximum bound in meters per second below which a particle's actual speed will be randomly chosen.

minimumImageSize

var minimumImageSize: Cartesian2

Sets the minimum bound, width by height, above which to randomly scale the particle image's dimensions in pixels.

var minimumMass: Double

Sets the minimum mass of particles in kilograms.

minimumParticleLife

var minimumParticleLife: Double

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.

var minimumSpeed: Double

Sets the minimum bound in meters per second above which a particle's actual speed will be randomly chosen.

var modelMatrix: Matrix4

The 4x4 transformation matrix that transforms the particle system from model to world coordinates.

var show: Boolean

Whether to display the particle system.

var sizeInMeters: Boolean

Gets or sets if the particle size is in meters or pixels. true to size particles in meters; otherwise, the size is in pixels.

var startColor: Color

The color of the particle at the beginning of its life.

var startScale: Double

The initial scale to apply to the image of the particle at the beginning of its life.

var updateCallback: UpdateCallback

An array of force callbacks. The callback is passed a Particle and the difference from the last time

Functions

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.

fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false.