Class CylinderParticleEmitter
Hierarchy
- CylinderParticleEmitter
Implements
Index
Constructors
constructor
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
direction RandomizerSearch playground for directionRandomizer
How much to randomize the particle direction [0-1].
heightSearch playground for height
The height of the emission cylinder.
radiusSearch playground for radius
The radius of the emission cylinder.
radius RangeSearch playground for radiusRange
The range of emission [0-1] 0 Surface only, 1 Entire Radius.
Methods
apply To ShaderSearch playground for applyToShader
Called by the GPUParticleSystem to setup the update shader
Parameters
uboOrEffect: UniformBufferEffectCommonAccessor
defines the update shader
Returns void
build Uniform LayoutSearch playground for buildUniformLayout
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
Clones the current emitter and returns a copy of it
Returns CylinderParticleEmitter
the new emitter
get Class NameSearch playground for getClassName
Returns the string "CylinderParticleEmitter"
Returns string
a string containing the class name
get Effect DefinesSearch playground for getEffectDefines
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
Returns void
serializeSearch playground for serialize
Serializes the particle system to a JSON object.
Returns any
the JSON object
start Direction FunctionSearch playground for 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
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
start Position FunctionSearch playground for 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
isLocal: boolean
defines if the position should be set in local space
Returns void
Particle emitter emitting particles from the inside of a cylinder. It emits the particles alongside the cylinder radius. The emission direction might be randomized.