Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubEmitter

Sub emitter class used to emit particles from an existing particle

Hierarchy

  • SubEmitter

Index

Constructors

constructor

  • Creates a sub emitter

    Parameters

    • particleSystem: ParticleSystem

      the particle system to be used by the sub emitter

    Returns SubEmitter

Properties

inheritDirectionSearch playground for inheritDirection

inheritDirection: boolean

If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false) Note: This only is supported when using an emitter of type Mesh

inheritedVelocityAmountSearch playground for inheritedVelocityAmount

inheritedVelocityAmount: number

How much of the attached particles speed should be added to the sub emitted particle (default: 0)

particleSystemSearch playground for particleSystem

particleSystem: ParticleSystem

the particle system to be used by the sub emitter

typeSearch playground for type

Type of the submitter (Default: END)

Methods

cloneSearch playground for clone

  • Clones the sub emitter

    Returns SubEmitter

    the cloned sub emitter

disposeSearch playground for dispose

  • dispose(): void
  • Release associated resources

    Returns void

serializeSearch playground for serialize

  • serialize(serializeTexture?: boolean): any
  • Serialize current object to a JSON object

    Parameters

    • Optional serializeTexture: boolean

      defines if the texture must be serialized as well

    Returns any

    the serialized object

Static ParseSearch playground for Parse

  • Creates a new SubEmitter from a serialized JSON version

    Parameters

    • serializationObject: any

      defines the JSON object to read from

    • sceneOrEngine: Scene | ThinEngine

      defines the hosting scene or the hosting engine

    • rootUrl: string

      defines the rootUrl for data loading

    Returns SubEmitter

    a new SubEmitter

Legend

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