API Docs for: v2.1.0
Show:

CGSGParticleEmitter Class

Extends CGSGNode
Defined in: src\node\class.particles.js:157
Module: ParticleSystem
Parent Module: Animation

A particle emitter for the cgSceneGraph Particle System

Constructor

CGSGParticleEmitter

(
  • nodeConstructor
  • region
  • nbParticlesMax
  • velocity
  • angle
  • speed
  • speedThreshold
  • outflow
)

Defined in src\node\class.particles.js:157

Parameters:

Methods

_createParticle

(
  • index
)
private

Defined in src\node\class.particles.js:373

create a new particle, and add it to the emitter

Parameters:

addForce

(
  • vector
  • ttl
)
Object public

Defined in src\node\class.particles.js:437

Add a force to the emitter

Parameters:

Returns:

Object:

initParticle

(
  • particle
  • index
)
public

Defined in src\node\class.particles.js:387

Parameters:

removeForce

(
  • force
)
public

Defined in src\node\class.particles.js:451

Remove a previously added force

Parameters:

render

(
  • context
)
public

Defined in src\node\class.particles.js:325

Parameters:

reset

() public

Defined in src\node\class.particles.js:309

reset the animation

start

() public

Defined in src\node\class.particles.js:291

start the animation

stop

() public

Defined in src\node\class.particles.js:300

stop the animation

updateParticle

(
  • particle
)
Boolean public

Defined in src\node\class.particles.js:415

Parameters:

Returns:

Boolean:

Properties

angle

Number

Defined in src\node\class.particles.js:215

angle range of emission. a particle is emitted in the this.direction vector + or - this.angle/2 angle.

gravity

Object

Defined in src\node\class.particles.js:261

Gravity Force added by default with the addForce method

nbParticlesMax

Number

Defined in src\node\class.particles.js:201

number max of particles out of the emitter on 1 frame

onInitParticle

Function

Defined in src\node\class.particles.js:275

Callback when reinit for 1 particle

Default: null

onInitParticlesEnd

Function

Defined in src\node\class.particles.js:282

Callback when reinit all particles is done

Default: null

onUpdateParticleEnd

Function

Defined in src\node\class.particles.js:268

Callback on end of update for 1 particle

Default: null

region

CGSGRegion

Defined in src\node\class.particles.js:195

the region from where the particles are emitted

speed

Number

Defined in src\node\class.particles.js:225

speed of a particle

speedThreshold

Number

Defined in src\node\class.particles.js:234

threshold to randomize and add to the speed of a particle