Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CylinderParticleEmitter

Particle emitter emitting particles from the inside of a cylinder. It emits the particles alongside the cylinder radius. The emission direction might be randomized.

Hierarchy

Implements

Index

Constructors

constructor

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

    Parameters

    • Optional radius: number

      the radius of the emission cylinder (1 by default)

    • Optional height: number

      the height of the emission cylinder (1 by default)

    • Optional radiusRange: number

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

    • Optional directionRandomizer: number

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

    Returns CylinderParticleEmitter

Properties

directionRandomizerSearch playground for directionRandomizer

directionRandomizer: number

How much to randomize the particle direction [0-1].

heightSearch playground for height

height: number

The height of the emission cylinder.

radiusSearch playground for radius

radius: number

The radius of the emission cylinder.

radiusRangeSearch playground for radiusRange

radiusRange: number

The range of emission [0-1] 0 Surface only, 1 Entire Radius.

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

    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