ParticleSystemSet

Represents a set of particle systems working together to create a specific effect

Hierarchy

  • ParticleSystemSet

Implements

Index

Properties

emitterNode

emitterNode: Nullable<TransformNode>

Gets the emitter node used with this set

systems

systems: IParticleSystem[]

Gets the particle system list

Methods

dispose

  • dispose(): void
  • Release all associated resources

    Returns void

serialize

  • serialize(): any
  • Serialize the set into a JSON compatible object

    Returns any

    a JSON compatible representation of the set

setEmitterAsSphere

  • setEmitterAsSphere(options: object, renderingGroupId: number, scene: Scene): void
  • Creates a new emitter mesh as a sphere

    Parameters

    • options: object

      defines the options used to create the sphere

      • color: Color3
      • diameter: number
      • segments: number
    • renderingGroupId: number

      defines the renderingGroupId to use for the sphere

    • scene: Scene

      defines the hosting scene

    Returns void

start

  • Starts all particle systems of the set

    Parameters

    • Optional emitter: AbstractMesh

      defines an optional mesh to use as emitter for the particle systems

    Returns void

Static Parse

  • Parse a new ParticleSystemSet from a serialized source

    Parameters

    • data: any

      defines a JSON compatible representation of the set

    • scene: Scene

      defines the hosting scene

    • Optional gpu: boolean

      defines if we want GPU particles or CPU particles

    Returns ParticleSystemSet

    a new ParticleSystemSet

Generated using TypeDoc