API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomParticleEmitter

Particle emitter emitting particles from a custom list of positions.

Hierarchy

  • CustomParticleEmitter

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new instance CustomParticleEmitter

    Returns CustomParticleEmitter

Properties

particleDestinationGeneratorSearch playground for particleDestinationGenerator

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

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

Type declaration

particlePositionGeneratorSearch playground for particlePositionGenerator

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

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

Type declaration

Methods

applyToShaderSearch playground for applyToShader

  • applyToShader(uboOrEffect: UniformBufferEffectCommonAccessor): void

  • Called by the GPUParticleSystem to setup the update shader

    Parameters

    • uboOrEffect: UniformBufferEffectCommonAccessor

      defines the update shader

    Returns void

buildUniformLayoutSearch playground for buildUniformLayout

cloneSearch playground for clone

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Returns the string "PointParticleEmitter"

    Returns string

    a string containing the class name

getEffectDefinesSearch playground for getEffectDefines

  • getEffectDefines(): string

  • Returns a string to use to update the GPU particles update shader

    Returns string

    a string containing the defines string

parseSearch playground for parse

  • parse(serializationObject: any): void

  • Parse properties from a JSON object

    Parameters

    • serializationObject: any

      defines the JSON object

    Returns void

serializeSearch playground for serialize

  • serialize(): any

  • Serializes the particle system to a JSON object.

    Returns any

    the JSON object

startDirectionFunctionSearch playground for startDirectionFunction

  • 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

startPositionFunctionSearch playground for startPositionFunction

  • 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 property
  • Inherited method
  • Static property
  • Static method