Class CylinderDirectedParticleEmitter

Particle emitter emitting particles from the inside of a cylinder. It emits the particles randomly between two vectors.

Hierarchy

CylinderParticleEmitter
- CylinderDirectedParticleEmitter

Implements

IParticleEmitterType

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CylinderDirectedParticleEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter

Overrides CylinderParticleEmitter.constructor
- Defined in .temp/docdirectory/doc.d.ts:74202
Creates a new instance CylinderDirectedParticleEmitter

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 direction1: Vector3
  
  the min limit of the emission direction (up vector by default)
- Optional direction2: Vector3
  
  the max limit of the emission direction (up vector by default)
Returns CylinderDirectedParticleEmitter

Properties

direction1Search playground for direction1

direction1: Vector3

The min limit of the emission direction.

direction2Search playground for direction2

direction2: Vector3

The max limit of the emission direction.

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

Implementation of IParticleEmitterType.applyToShader

Overrides CylinderParticleEmitter.applyToShader
- Defined in .temp/docdirectory/doc.d.ts:74235
Called by the GPUParticleSystem to setup the update shader

Parameters
- uboOrEffect: UniformBufferEffectCommonAccessor
  
  defines the update shader
Returns void

buildUniformLayoutSearch playground for buildUniformLayout

buildUniformLayout(ubo: UniformBuffer): void

Implementation of IParticleEmitterType.buildUniformLayout

Overrides CylinderParticleEmitter.buildUniformLayout
- Defined in .temp/docdirectory/doc.d.ts:74240
Creates the structure of the ubo for this particle emitter

Parameters
- ubo: UniformBuffer
  
  ubo to create the structure for
Returns void

cloneSearch playground for clone

clone(): CylinderDirectedParticleEmitter

Implementation of IParticleEmitterType.clone

Overrides CylinderParticleEmitter.clone
- Defined in .temp/docdirectory/doc.d.ts:74230
Clones the current emitter and returns a copy of it

Returns CylinderDirectedParticleEmitter

the new emitter

getClassNameSearch playground for getClassName

getClassName(): string

Implementation of IParticleEmitterType.getClassName

Overrides CylinderParticleEmitter.getClassName
- Defined in .temp/docdirectory/doc.d.ts:74250
Returns the string "CylinderDirectedParticleEmitter"

Returns string

a string containing the class name

getEffectDefinesSearch playground for getEffectDefines

getEffectDefines(): string

Implementation of IParticleEmitterType.getEffectDefines

Overrides CylinderParticleEmitter.getEffectDefines
- Defined in .temp/docdirectory/doc.d.ts:74245
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

Overrides CylinderParticleEmitter.parse
- Defined in .temp/docdirectory/doc.d.ts:74260
Parse properties from a JSON object

Parameters
- serializationObject: any
  
  defines the JSON object
Returns void

serializeSearch playground for serialize

serialize(): any

Implementation of IParticleEmitterType.serialize

Overrides CylinderParticleEmitter.serialize
- Defined in .temp/docdirectory/doc.d.ts:74255
Serializes the particle system to a JSON object.

Returns any

the JSON object

startDirectionFunctionSearch playground for startDirectionFunction

startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3): void

Overrides CylinderParticleEmitter.startDirectionFunction
- Defined in .temp/docdirectory/doc.d.ts:74225
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
Returns void

startPositionFunctionSearch playground for startPositionFunction

startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void

Implementation of IParticleEmitterType.startPositionFunction

Inherited from CylinderParticleEmitter.startPositionFunction
- Defined in .temp/docdirectory/doc.d.ts:74153
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

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional radius: number

Optional height: number

Optional radiusRange: number

Optional direction1: Vector3

Optional direction2: Vector3

Returns CylinderDirectedParticleEmitter

Properties

direction1Search playground for direction1

direction2Search playground for direction2

directionRandomizerSearch playground for directionRandomizer

heightSearch playground for height

radiusSearch playground for radius

radiusRangeSearch playground for radiusRange

Methods

applyToShaderSearch playground for applyToShader

Parameters

uboOrEffect: UniformBufferEffectCommonAccessor

Returns void

buildUniformLayoutSearch playground for buildUniformLayout

Parameters

ubo: UniformBuffer

Returns void

cloneSearch playground for clone

Returns CylinderDirectedParticleEmitter

getClassNameSearch playground for getClassName

Returns string

getEffectDefinesSearch playground for getEffectDefines

Returns string

parseSearch playground for parse

Parameters

serializationObject: any

Returns void

serializeSearch playground for serialize

Returns any

startDirectionFunctionSearch playground for startDirectionFunction

Parameters

worldMatrix: Matrix

directionToUpdate: Vector3

Returns void

startPositionFunctionSearch playground for startPositionFunction

Parameters

worldMatrix: Matrix

positionToUpdate: Vector3

particle: Particle

isLocal: boolean

Returns void