Class ParticleGPUSimulationSettings

acceleration

• get acceleration(): Immutable<Vector3>

  Constant acceleration to apply for each step of the simulation.

  Returns Immutable<Vector3>

• set acceleration(value: Immutable<Vector3>): void

  Parameters

  • value: Immutable<Vector3>

  Returns void

colorOverLifetime

• get colorOverLifetime(): ColorDistribution

  Determines particle color, evaluated over the particle lifetime.

  Returns ColorDistribution

• set colorOverLifetime(
      value: Immutable<Color> | ColorGradient | ColorDistribution,
  ): void

  Parameters

  • value: Immutable<Color> | ColorGradient | ColorDistribution

  Returns void

depthCollision

• get depthCollision(): ParticleDepthCollisionSettings

  Settings controlling particle depth buffer collisions.

  Returns ParticleDepthCollisionSettings

• set depthCollision(value: ParticleDepthCollisionSettings): void

  Parameters

  • value: ParticleDepthCollisionSettings

  Returns void

drag

• get drag(): number

  Amount of resistance to apply in the direction opposite of the particle's velocity.

  Returns number

• set drag(value: number): void

  Parameters

  • value: number

  Returns void

sizeScaleOverLifetime

• get sizeScaleOverLifetime(): Vector2Distribution

  Determines particle size, evaluated over the particle lifetime. Multiplied by the initial particle size.

  Returns Vector2Distribution

• set sizeScaleOverLifetime(
      value: Immutable<Vector2> | CompoundVector2Curve | Vector2Distribution,
  ): void

  Parameters

  • value: Immutable<Vector2> | CompoundVector2Curve | Vector2Distribution

  Returns void

vectorField

• get vectorField(): ParticleVectorFieldSettings

  Represents a three dimensional field of vectors. It is represented by spatial bounds which are split into a grid of values with user-defined density, where each grid cell is assigned a vector.

  Returns ParticleVectorFieldSettings

• set vectorField(value: ParticleVectorFieldSettings): void

  Parameters

  • value: ParticleVectorFieldSettings

  Returns void

markAsDirty

• markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void

  Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action: () => void): void

  Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

  Parameters

  • action: () => void

    The scope where the object is modified.

  Returns void

ReadonlyonDirty