ConstructorOptions

external interface ConstructorOptions(source)

Properties

Link copied to clipboard
abstract external val bursts: ReadonlyArray<ParticleBurst>?

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

Link copied to clipboard
abstract external val color: Color?

Sets the color of a particle for the duration of its particleLife. Default value - Color.WHITE

Link copied to clipboard
abstract external val emissionRate: Int?

The number of particles to emit per second. Default value - 5

Link copied to clipboard
abstract external val emitter: ParticleEmitter?

The particle emitter for this system. Default value - CircleEmitter(0.5)

Link copied to clipboard
abstract external val emitterModelMatrix: Matrix4?

The 4x4 transformation matrix that transforms the particle system emitter within the particle systems local coordinate system. Default value - Matrix4.IDENTITY

Link copied to clipboard
abstract external val endColor: Color?

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

Link copied to clipboard
abstract external val endScale: Double?

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

Link copied to clipboard
abstract external val image: JsAny?

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

Link copied to clipboard
abstract external val imageSize: Cartesian2?

If set, overrides the minimumImageSize and maximumImageSize inputs that scale the particle image's dimensions in pixels. Default value - Cartesian2(1.0, 1.0)

Link copied to clipboard
abstract external val lifetime: Double?

How long the particle system will emit particles, in seconds. Default value - Number.MAX_VALUE

Link copied to clipboard
abstract external val loop: Boolean?

Whether the particle system should loop its bursts when it is complete. Default value - true

Link copied to clipboard
abstract external val mass: Double?

Sets the minimum and maximum mass of particles in kilograms. Default value - 1.0

Link copied to clipboard
abstract external val maximumImageSize: Cartesian2?

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

Link copied to clipboard
abstract external val maximumMass: Double?

Sets the maximum mass of particles in kilograms. A particle's actual mass will be chosen as a random amount below this value.

Link copied to clipboard
abstract external val 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.

Link copied to clipboard
abstract external val maximumSpeed: Double?

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

Link copied to clipboard
abstract external val minimumImageSize: Cartesian2?

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

Link copied to clipboard
abstract external val minimumMass: Double?

Sets the minimum bound for the mass of a particle in kilograms. A particle's actual mass will be chosen as a random amount above this value.

Link copied to clipboard
abstract external val 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.

Link copied to clipboard
abstract external val minimumSpeed: Double?

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

Link copied to clipboard
abstract external val modelMatrix: Matrix4?

The 4x4 transformation matrix that transforms the particle system from model to world coordinates. Default value - Matrix4.IDENTITY

Link copied to clipboard
abstract external val particleLife: Double?

If set, overrides the minimumParticleLife and maximumParticleLife inputs with this value. Default value - 5.0

Link copied to clipboard
abstract external val scale: Double?

Sets the scale to apply to the image of the particle for the duration of its particleLife. Default value - 1.0

Link copied to clipboard
abstract external val show: Boolean?

Whether to display the particle system. Default value - true

Link copied to clipboard
abstract external val sizeInMeters: Boolean?

Sets if the size of particles is in meters or pixels. true to size the particles in meters; otherwise, the size is in pixels.

Link copied to clipboard
abstract external val speed: Double?

If set, overrides the minimumSpeed and maximumSpeed inputs with this value. Default value - 1.0

Link copied to clipboard
abstract external val startColor: Color?

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

Link copied to clipboard
abstract external val startScale: Double?

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

Link copied to clipboard
abstract external val updateCallback: UpdateCallback?

The callback function to be called each frame to update a particle.