NvsParticleSystemContext Class Reference

Particle effect context The particle system is composed of several particle emitters and sub-emitters. The particle emitter emits particles over time, and the sub-emitter emits particles from the particles emitted by the particle emitter. More...

Public Member Functions
	constructor ()
	setEmitterEnabled (emitterName, enable)
	Set whether to enable the emitter. More...
	setEmitterPosition (emitterName, emitterPositionX, emitterPositionY)
	Set the particle emitter's position. More...
	appendPositionToEmitterPositionCurve (emitterName, timeSec, emitterPositionX, emitterPositionY)
	Append a path position to the particle emitter curve at the specified time point. More...
	setEmitterRateGain (emitterName, emitterGain)
	Set the rate gain of the particles emitted by the particle emitter. More...
	getEmitterRateGain (emitterName)
	Get the rate gain of the particles emitted by the particle emitter. More...
	setEmitterParticleSizeGain (emitterName, emitterGain)
	Set the size gain of the particles emitted by the particle emitter. More...
	getEmitterParticleSizeGain (emitterName)
	Get the size gain of the particles emitted by the particle emitter. More...
	getAllEmitterCurve ()
	Get a list of all the emitter curve informations. More...

Detailed Description

Particle effect context The particle system is composed of several particle emitters and sub-emitters. The particle emitter emits particles over time, and the sub-emitter emits particles from the particles emitted by the particle emitter.

Member Function Documentation

appendPositionToEmitterPositionCurve()

NvsParticleSystemContext::appendPositionToEmitterPositionCurve (   emitterName,   timeSec,   emitterPositionX,   emitterPositionY  )

inline

Append a path position to the particle emitter curve at the specified time point.

Parameters

{String}	emitterName emitter name
{Number}	timeSec time point
{Number}	emitterPositionX particle emitter's X coordinate
{Number}	emitterPositionY particle emitter's Y coordinate

Returns

{}

constructor()

NvsParticleSystemContext::constructor ( )

inline

@constructor

getAllEmitterCurve()

NvsParticleSystemContext::getAllEmitterCurve ( )

inline

Get a list of all the emitter curve informations.

Returns

{NvsVectorVal<NvsEmitterCurveInfo>} Return the obtained list collection containing all the emitter curve information objects.

getEmitterParticleSizeGain()

NvsParticleSystemContext::getEmitterParticleSizeGain (   emitterName )

inline

Get the size gain of the particles emitted by the particle emitter.

Parameters

{String}

emitterName emitter name

Returns

{Number} size gain

getEmitterRateGain()

NvsParticleSystemContext::getEmitterRateGain (   emitterName )

inline

Get the rate gain of the particles emitted by the particle emitter.

Parameters

{String}

emitterName emitter name

Returns

{Number} rate gain

setEmitterEnabled()

NvsParticleSystemContext::setEmitterEnabled (   emitterName,   enable  )

inline

Set whether to enable the emitter.

Parameters

{String}	emitterName emitter name
{Boolean}	enable enable or disable, default mode is enable.

Returns

{}

setEmitterParticleSizeGain()

NvsParticleSystemContext::setEmitterParticleSizeGain (   emitterName,   emitterGain  )

inline

Set the size gain of the particles emitted by the particle emitter.

Parameters

{String}	emitterName emitter name
{Number}	emitterGain emission size gain

Returns

{}

setEmitterPosition()

NvsParticleSystemContext::setEmitterPosition (   emitterName,   emitterPositionX,   emitterPositionY  )

inline

Set the particle emitter's position.

Parameters

{String}	emitterName emitter name
{Number}	emitterPositionX particle emitter's X coordinate
{Number}	emitterPositionY particle emitter's Y coordinate

Returns

{}

setEmitterRateGain()

NvsParticleSystemContext::setEmitterRateGain (   emitterName,   emitterGain  )

inline

Set the rate gain of the particles emitted by the particle emitter.

Parameters

{String}	emitterName emitter name
{Number}	emitterGain emission rate gain

Returns

{}

---

The documentation for this class was generated from the following file:

• src/js/NvStreamingSdk.js