Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MeshParticleEmitter

Particle emitter emitting particles from the inside of a box. It emits the particles randomly between 2 given directions.

Hierarchy

  • MeshParticleEmitter

Implements

Index

Constructors

constructor

  • Creates a new instance MeshParticleEmitter

    Parameters

    Returns MeshParticleEmitter

Properties

direction1Search playground for direction1

direction1: Vector3

Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.

direction2Search playground for direction2

direction2: Vector3

Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.

useMeshNormalsForDirectionSearch playground for useMeshNormalsForDirection

useMeshNormalsForDirection: boolean

Gets or sets a boolean indicating that particle directions must be built from mesh face normals

Accessors

mesh

  • Defines the mesh to use as source

    Returns Nullable<AbstractMesh>

  • Defines the mesh to use as source

    Parameters

    Returns any

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 "BoxParticleEmitter"

    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 properties from a JSON object

    Parameters

    • serializationObject: any

      defines the JSON object

    • scene: Nullable<Scene>

      defines the hosting scene

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