Class CylinderParticleEmitter

constructor

• new CylinderParticleEmitter(
      radius?: number,
      height?: number,
      radiusRange?: number,
      directionRandomizer?: number,
  ): CylinderParticleEmitter

  Creates a new instance CylinderParticleEmitter

  Parameters

  • radius: number = 1

    the radius of the emission cylinder (1 by default)

  • height: number = 1

    the height of the emission cylinder (1 by default)

  • radiusRange: number = 1

    the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)

  • directionRandomizer: number = 0

    defines how much to randomize the particle direction [0-1]

  Returns CylinderParticleEmitter

directionRandomizer

height

radius

radiusRange

applyToShader

• applyToShader(uboOrEffect: UniformBufferEffectCommonAccessor): void

  Called by the GPUParticleSystem to setup the update shader

  Parameters

  • uboOrEffect: UniformBufferEffectCommonAccessor

    defines the update shader

  Returns void

buildUniformLayout

• buildUniformLayout(ubo: UniformBuffer): void

  Creates the structure of the ubo for this particle emitter

  Parameters

  • ubo: UniformBuffer

    ubo to create the structure for

  Returns void

clone

• clone(): CylinderParticleEmitter

  Clones the current emitter and returns a copy of it

  Returns CylinderParticleEmitter

  the new emitter

getClassName

• getClassName(): string

  Returns the string "CylinderParticleEmitter"

  Returns string

  a string containing the class name

getEffectDefines

• getEffectDefines(): string

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

  Returns string

  a string containing the defines string

parse

• parse(serializationObject: any): void

  Parse properties from a JSON object

  Parameters

  • serializationObject: any

    defines the JSON object

  Returns void

serialize

• serialize(): any

  Serializes the particle system to a JSON object.

  Returns any

  the JSON object

startDirectionFunction

• startDirectionFunction(
      worldMatrix: Matrix,
      directionToUpdate: Vector3,
      particle: Particle,
      isLocal: boolean,
      inverseWorldMatrix: Matrix,
  ): 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

  • inverseWorldMatrix: Matrix

    defines the inverted world matrix to use if isLocal is false

  Returns void

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