Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticleSystemSet

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

Hierarchy

  • ParticleSystemSet

Implements

Index

Properties

systemsSearch playground for systems

systems: IParticleSystem[]

Gets the particle system list

Static BaseAssetsUrlSearch playground for BaseAssetsUrl

BaseAssetsUrl: string

Gets or sets base Assets URL

Accessors

emitterNode

  • Gets or sets the emitter node used with this set

    Returns Nullable<AbstractMesh | Vector3>

  • Gets or sets the emitter node used with this set

    Parameters

    Returns any

Methods

disposeSearch playground for dispose

  • dispose(): void
  • Release all associated resources

    Returns void

serializeSearch playground for serialize

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

    Parameters

    • Optional serializeTexture: boolean

      defines if the texture must be serialized as well

    Returns any

    a JSON compatible representation of the set

setEmitterAsSphereSearch playground for setEmitterAsSphere

  • setEmitterAsSphere(options: { color: Color3; diameter: number; segments: number }, renderingGroupId: number, scene: Scene): void
  • Creates a new emitter mesh as a sphere

    Parameters

    • options: { color: Color3; diameter: number; segments: number }

      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

startSearch playground for 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 ParseSearch playground for 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

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method