ParticleEmitterComponent.ParticleEmitter

noiseScale

get noiseScale(): number

var noiseScale: Float

Scale of the noise (turbulence) patterns. Defaults to 1.

noiseScale

set noiseScale(value: number)

var noiseScale: Float

Scale of the noise (turbulence) patterns. Defaults to 1.

acceleration

get acceleration(): SDKHandle

var acceleration: SIMD3<Float>

The constant acceleration vector, in meters per second squared, applied to all particles in the system.

acceleration

set acceleration(value: SDKHandle)

var acceleration: SIMD3<Float>

The constant acceleration vector, in meters per second squared, applied to all particles in the system.

angularSpeed

get angularSpeed(): number

var angularSpeed: Float

The initial spin rate, in radians per second, of newly spawned particles. Defaults to 0.

angularSpeed

set angularSpeed(value: number)

var angularSpeed: Float

The initial spin rate, in radians per second, of newly spawned particles. Defaults to 0.

opacityCurve

get opacityCurve(): ParticleEmitterComponent_ParticleEmitter_OpacityCurve

var opacityCurve: ParticleEmitterComponent.ParticleEmitter.OpacityCurve

The curve of opacity change over the lifetime of the particle. Defaults to `quickFadeInOut`.

opacityCurve

set opacityCurve(value: ParticleEmitterComponent_ParticleEmitter_OpacityCurve)

var opacityCurve: ParticleEmitterComponent.ParticleEmitter.OpacityCurve

The curve of opacity change over the lifetime of the particle. Defaults to `quickFadeInOut`.

billboardMode

get billboardMode(): ParticleEmitterComponent_ParticleEmitter_BillboardMode

var billboardMode: ParticleEmitterComponent.ParticleEmitter.BillboardMode

The mode defining whether and how particles orient towards the camera. Defaults to `billboardYAligned`.

billboardMode

set billboardMode(value: ParticleEmitterComponent_ParticleEmitter_BillboardMode)

var billboardMode: ParticleEmitterComponent.ParticleEmitter.BillboardMode

The mode defining whether and how particles orient towards the camera. Defaults to `billboardYAligned`.

dampingFactor

get dampingFactor(): number

var dampingFactor: Float

A factor that slows particles relative to their velocity. Defaults to 0.

dampingFactor

set dampingFactor(value: number)

var dampingFactor: Float

A factor that slows particles relative to their velocity. Defaults to 0.

imageSequence

get imageSequence(): (ParticleEmitterComponent_ParticleEmitter_ImageSequence) | null

var imageSequence: ParticleEmitterComponent.ParticleEmitter.ImageSequence?

Determines if the particle image is a sprite sheet (used for animation).

imageSequence

set imageSequence(value: (ParticleEmitterComponent_ParticleEmitter_ImageSequence) | null)

var imageSequence: ParticleEmitterComponent.ParticleEmitter.ImageSequence?

Determines if the particle image is a sprite sheet (used for animation).

massVariation

get massVariation(): number

var massVariation: Float

Defines a plus/minus range (in grams) from which a value is randomly selected to offset `mass`.

massVariation

set massVariation(value: number)

var massVariation: Float

Defines a plus/minus range (in grams) from which a value is randomly selected to offset `mass`.

noiseStrength

get noiseStrength(): number

var noiseStrength: Float

Strength of the noise (turbulence) fields affecting particle motion. Defaults to 0.

noiseStrength

set noiseStrength(value: number)

var noiseStrength: Float

Strength of the noise (turbulence) fields affecting particle motion. Defaults to 0.

sizeVariation

get sizeVariation(): number

var sizeVariation: Float

Defines a plus/minus range from which a value is randomly selected to offset `size`.

sizeVariation

set sizeVariation(value: number)

var sizeVariation: Float

Defines a plus/minus range from which a value is randomly selected to offset `size`.

stretchFactor

get stretchFactor(): number

var stretchFactor: Float

How much a particle's shape is stretched along its velocity direction (Billboard particles only).

stretchFactor

set stretchFactor(value: number)

var stretchFactor: Float

How much a particle's shape is stretched along its velocity direction (Billboard particles only).

angleVariation

get angleVariation(): number

var angleVariation: Float

Defines a plus/minus range (in radians) from which a value is randomly selected to offset `angle`.

angleVariation

set angleVariation(value: number)

var angleVariation: Float

Defines a plus/minus range (in radians) from which a value is randomly selected to offset `angle`.

spreadingAngle

get spreadingAngle(): number

var spreadingAngle: Float

The range, in radians, of randomized initial particle directions as radians describing the size of the spreading cone. Defaults to 0.

spreadingAngle

set spreadingAngle(value: number)

var spreadingAngle: Float

The range, in radians, of randomized initial particle directions as radians describing the size of the spreading cone. Defaults to 0.

vortexStrength

get vortexStrength(): number

var vortexStrength: Float

Strength of the vortex forces affecting particle motion. Defaults to 0.

vortexStrength

set vortexStrength(value: number)

var vortexStrength: Float

Strength of the vortex forces affecting particle motion. Defaults to 0.

vortexDirection

get vortexDirection(): SDKHandle

var vortexDirection: SIMD3<Float>

Direction vector of the vortex axis. Defaults to (0, 1, 0).

vortexDirection

set vortexDirection(value: SDKHandle)

var vortexDirection: SIMD3<Float>

Direction vector of the vortex axis. Defaults to (0, 1, 0).

attractionCenter

get attractionCenter(): SDKHandle

var attractionCenter: SIMD3<Float>

The spot that the particles are attracted to. In local space. Defaults to (1, 1, 0).

attractionCenter

set attractionCenter(value: SDKHandle)

var attractionCenter: SIMD3<Float>

The spot that the particles are attracted to. In local space. Defaults to (1, 1, 0).

isLightingEnabled

get isLightingEnabled(): boolean

var isLightingEnabled: Bool

Determines if particles are affected by scene lighting.

isLightingEnabled

set isLightingEnabled(value: boolean)

var isLightingEnabled: Bool

Determines if particles are affected by scene lighting.

lifeSpanVariation

get lifeSpanVariation(): number

var lifeSpanVariation: Double

Defines a plus/minus range (in seconds) from which a value is randomly selected to offset `lifeSpan`. Defaults to 0.2.

lifeSpanVariation

set lifeSpanVariation(value: number)

var lifeSpanVariation: Double

Defines a plus/minus range (in seconds) from which a value is randomly selected to offset `lifeSpan`. Defaults to 0.2.

attractionStrength

get attractionStrength(): number

var attractionStrength: Float

The particles are attracted to the `attractionCenter` by this amount. Defaults to 0.

attractionStrength

set attractionStrength(value: number)

var attractionStrength: Float

The particles are attracted to the `attractionCenter` by this amount. Defaults to 0.

birthRateVariation

get birthRateVariation(): number

var birthRateVariation: Float

Defines a plus/minus range from which a value is randomly selected to offset `birthRate`.

birthRateVariation

set birthRateVariation(value: number)

var birthRateVariation: Float

Defines a plus/minus range from which a value is randomly selected to offset `birthRate`.

colorEvolutionPower

get colorEvolutionPower(): number

var colorEvolutionPower: Float

How quickly the color evolves from its start to its end color — a value of 1 is a linear transition, values below 1 transition quicker, values over 1 transition slower.

colorEvolutionPower

set colorEvolutionPower(value: number)

var colorEvolutionPower: Float

How quickly the color evolves from its start to its end color — a value of 1 is a linear transition, values below 1 transition quicker, values over 1 transition slower.

noiseAnimationSpeed

get noiseAnimationSpeed(): number

var noiseAnimationSpeed: Float

Determines how fast the noise field changes over time. Defaults to 0.

noiseAnimationSpeed

set noiseAnimationSpeed(value: number)

var noiseAnimationSpeed: Float

Determines how fast the noise field changes over time. Defaults to 0.

angularSpeedVariation

get angularSpeedVariation(): number

var angularSpeedVariation: Float

Defines a plus/minus range (in radians per second) from which a value is randomly selected to offset `angularSpeed`.

angularSpeedVariation

set angularSpeedVariation(value: number)

var angularSpeedVariation: Float

Defines a plus/minus range (in radians per second) from which a value is randomly selected to offset `angularSpeed`.

sizeMultiplierAtEndOfLifespan

get sizeMultiplierAtEndOfLifespan(): number

var sizeMultiplierAtEndOfLifespan: Float

At the end of the particle lifespan, the particle's size will be it's initial size times this multiplier. Defaults to 0.1.

sizeMultiplierAtEndOfLifespan

set sizeMultiplierAtEndOfLifespan(value: number)

var sizeMultiplierAtEndOfLifespan: Float

At the end of the particle lifespan, the particle's size will be it's initial size times this multiplier. Defaults to 0.1.

sizeMultiplierAtEndOfLifespanPower

get sizeMultiplierAtEndOfLifespanPower(): number

var sizeMultiplierAtEndOfLifespanPower: Float

How quickly or slowly particle size changes over its lifetime — a value of 1 is linear, values below 1 transition quicker, values above 1 transition slower.

sizeMultiplierAtEndOfLifespanPower

set sizeMultiplierAtEndOfLifespanPower(value: number)

var sizeMultiplierAtEndOfLifespanPower: Float

How quickly or slowly particle size changes over its lifetime — a value of 1 is linear, values below 1 transition quicker, values above 1 transition slower.

mass

get mass(): number

var mass: Float

The mass, in grams, of each particle in the system. Defaults to 1.

mass

set mass(value: number)

var mass: Float

The mass, in grams, of each particle in the system. Defaults to 1.

size

get size(): number

var size: Float

The rendered size, in units of the scene’s world coordinate space, of the particle image. Value is the half-extent of the particle's quad. Defaults to 0.02.

size

set size(value: number)

var size: Float

The rendered size, in units of the scene’s world coordinate space, of the particle image. Value is the half-extent of the particle's quad. Defaults to 0.02.

angle

get angle(): number

var angle: Float

The rotation angle, in radians, of newly spawned particles. Defaults to 0.

angle

set angle(value: number)

var angle: Float

The rotation angle, in radians, of newly spawned particles. Defaults to 0.

image

get image(): (TextureResource) | null

var image: TextureResource?

The image that each particle will use (requires pre-multiplied RGB values). Defaults to a white circular texture.

image

set image(value: (TextureResource) | null)

var image: TextureResource?

The image that each particle will use (requires pre-multiplied RGB values). Defaults to a white circular texture.

lifeSpan

get lifeSpan(): number

var lifeSpan: Double

The duration, in seconds, for which each particle is rendered before being removed from the scene. Defaults to 1.

lifeSpan

set lifeSpan(value: number)

var lifeSpan: Double

The duration, in seconds, for which each particle is rendered before being removed from the scene. Defaults to 1.

birthRate

get birthRate(): number

var birthRate: Float

The number of particles emitted over the emission duration. Defaults to 100.

birthRate

set birthRate(value: number)

var birthRate: Float

The number of particles emitted over the emission duration. Defaults to 100.

blendMode

get blendMode(): ParticleEmitterComponent_ParticleEmitter_BlendMode

var blendMode: ParticleEmitterComponent.ParticleEmitter.BlendMode

How overlapping particles are composited together. Defaults to `alpha`.

blendMode

set blendMode(value: ParticleEmitterComponent_ParticleEmitter_BlendMode)

var blendMode: ParticleEmitterComponent.ParticleEmitter.BlendMode

How overlapping particles are composited together. Defaults to `alpha`.

sortOrder

get sortOrder(): ParticleEmitterComponent_ParticleEmitter_SortOrder

var sortOrder: ParticleEmitterComponent.ParticleEmitter.SortOrder

How overlapping particles are sorted before rendering. Defaults to `increasingDepth`.

sortOrder

set sortOrder(value: ParticleEmitterComponent_ParticleEmitter_SortOrder)

var sortOrder: ParticleEmitterComponent.ParticleEmitter.SortOrder

How overlapping particles are sorted before rendering. Defaults to `increasingDepth`.

init

static init(): ParticleEmitterComponent_ParticleEmitter

init()