ParticleEmitter Class

Extends Points
Module: Particles

Particle emitter is a wrapper for SPE particle system.

SPE is a threejs based particle emitter engine.

Documentation for SPE particle engine can be found here https://squarefeet.github.io/ShaderParticleEngine/docs/api/index.html

Methods

dispose

()

Dispose particle emitter.

Should be called when destroying particle emitter.

onBeforeRender

()

Particle emitter state is automatically updated before rendering.

reload

()

Reload internal material and geometry.

May be required after changing material related parameters.

toJSON

(
  • meta
)
Object

Serialize object to JSON.

Parameters:

  • meta Object

Returns:

Object:

json

updateMatrix

()

Update particle object matrix.

Ignores the particle position if the moveEmitter attribute is set true.

Properties

emitter

SPE.Emitter

SPE Emitter instance.

Emitter has attributes that can be used to controll the particle system

https://squarefeet.github.io/ShaderParticleEngine/docs/api/SPE.Emitter.html

Attributes

defaultEmitter

Object

Default particle emitter configuration.

defaultGroup

Object

Default particle emitter group configuration.