Options
All
  • Public
  • Public/Protected
  • All
Menu

Particle emitter emitting particles from a custom list of positions.

Hierarchy

  • CustomParticleEmitter

Implements

Index

Constructors

  • Creates a new instance CustomParticleEmitter

    Returns CustomParticleEmitter

Properties

particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void

Type declaration

    • Gets or sets the destination generator that will create the final destination of each particle.

      • Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles

      Parameters

      Returns void

particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void

Type declaration

    • Gets or sets the position generator that will create the initial position of each particle. Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles

      Parameters

      Returns void

Methods

  • applyToShader(uboOrEffect: UniformBufferEffectCommonAccessor): void
  • Called by the GPUParticleSystem to setup the update shader

    Parameters

    • uboOrEffect: UniformBufferEffectCommonAccessor

      defines the update shader

    Returns void

  • getClassName(): string
  • Returns the string "PointParticleEmitter"

    Returns string

    a string containing the class name

  • getEffectDefines(): string
  • Returns a string to use to update the GPU particles update shader

    Returns string

    a string containing the defines string

  • parse(serializationObject: any): void
  • Parse properties from a JSON object

    Parameters

    • serializationObject: any

      defines the JSON object

    Returns void

  • serialize(): any
  • Serializes the particle system to a JSON object.

    Returns any

    the JSON object

  • startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void
  • Called by the particle System when the direction is computed for the created particle.

    Parameters

    • worldMatrix: Matrix

      is the world matrix of the particle system

    • directionToUpdate: Vector3

      is the direction vector to update with the result

    • particle: Particle

      is the particle we are computed the direction for

    • isLocal: boolean

      defines if the direction should be set in local space

    Returns void

  • startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void
  • Called by the particle System when the position is computed for the created particle.

    Parameters

    • worldMatrix: Matrix

      is the world matrix of the particle system

    • positionToUpdate: Vector3

      is the position vector to update with the result

    • particle: Particle

      is the particle we are computed the position for

    • isLocal: boolean

      defines if the position should be set in local space

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme