ConeParticleEmitter

Particle emitter emitting particles from the inside of a cone. It emits the particles alongside the cone volume from the base to the particle. The emission direction might be randomized.

Hierarchy

  • ConeParticleEmitter

Implements

Index

Constructors

constructor

  • new ConeParticleEmitter(radius?: number, angle?: number, directionRandomizer?: number): ConeParticleEmitter
  • Creates a new instance ConeParticleEmitter

    Parameters

    • Optional radius: number

      the radius of the emission cone (1 by default)

    • Optional angle: number
    • Optional directionRandomizer: number

      defines how much to randomize the particle direction [0-1] (default is 0)

    Returns ConeParticleEmitter

Properties

angle

angle: number

Gets or sets the angle of the emission cone

directionRandomizer

directionRandomizer: number

defines how much to randomize the particle direction [0-1] (default is 0)

emitFromSpawnPointOnly

emitFromSpawnPointOnly: boolean

Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)

heightRange

heightRange: number

Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)

radius

radius: number

Gets or sets the radius of the emission cone

radiusRange

radiusRange: number

Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)

Methods

applyToShader

  • applyToShader(effect: Effect): void
  • Called by the GPUParticleSystem to setup the update shader

    Parameters

    • effect: Effect

      defines the update shader

    Returns void

clone

getClassName

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

    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 containng 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

  • 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

    Returns void

startPositionFunction

  • 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

    Returns void

Generated using TypeDoc