Particle Systems

Functions
int	SO3ParticleSystemCreateFromTemplate (mmachine m)
	main include
int	SO3ParticleSystemGetTemplate (mmachine m)
	SO3ParticleSystemGetTemplate : Get the template for particle system.
int	SO3ParticleSystemSetEnable (mmachine m)
	SO3ParticleSystemSetEnable : Set the Enable state for particle system.
int	SO3ParticleSystemGetEnable (mmachine m)
	SO3ParticleSystemGetEnable : Get the enable state for particle system.
int	SO3ParticleSystemSetPause (mmachine m)
	SO3ParticleSystemSetPause : Set the pause state for particle system.
int	SO3ParticleSystemGetPause (mmachine m)
	SO3ParticleSystemGetPause : Get the pause state for particle system.
int	SO3ParticleSystemSetSpeedFactor (mmachine m)
	SO3ParticleSystemSetSpeedFactor : Set the speed factor for particle system.
int	SO3ParticleSystemGetSpeedFactor (mmachine m)
	SO3ParticleSystemGetSpeedFactor : Get the speed factor for particle system.
int	SO3ParticleSystemClear (mmachine m)
	SO3ParticleSystemClear : Clear a set of particle for a given particle system.

---

Detailed Description

Scol functions definition

---

Function Documentation

int SO3ParticleSystemClear

(

mmachine

m

)

SO3ParticleSystemClear : Clear a set of particle for a given particle system.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : 1 if success , NIL otherwise

Definition at line 417 of file SCOLParticle.cpp.

int SO3ParticleSystemCreateFromTemplate

(

mmachine

m

)

main include

SO3ParticleSystemCreateFromTemplate : Create a new particle system based on a given template name Prototype: fun [SO3_SCENE S S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: given name
	S	: given template

Returns:

SO3_OBJECT : The particle system if success , NIL otherwise

Definition at line 55 of file SCOLParticle.cpp.

int SO3ParticleSystemGetEnable

(

mmachine

m

)

SO3ParticleSystemGetEnable : Get the enable state for particle system.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Enable state if success , NIL otherwise

Definition at line 199 of file SCOLParticle.cpp.

int SO3ParticleSystemGetPause

(

mmachine

m

)

SO3ParticleSystemGetPause : Get the pause state for particle system.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Pause state if success , NIL otherwise

Definition at line 290 of file SCOLParticle.cpp.

int SO3ParticleSystemGetSpeedFactor

(

mmachine

m

)

SO3ParticleSystemGetSpeedFactor : Get the speed factor for particle system.

Prototype: fun [SO3_OBJECT] F

Parameters:

SO3_OBJECT

: current node

Returns:

F : Speed factor if success , NIL otherwise

Definition at line 377 of file SCOLParticle.cpp.

int SO3ParticleSystemGetTemplate

(

mmachine

m

)

SO3ParticleSystemGetTemplate : Get the template for particle system.

Prototype: fun [SO3_OBJECT] S

Parameters:

SO3_OBJECT

: current node

Returns:

S : Template Name if success , NIL otherwise

Definition at line 106 of file SCOLParticle.cpp.

int SO3ParticleSystemSetEnable

(

mmachine

m

)

SO3ParticleSystemSetEnable : Set the Enable state for particle system.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 152 of file SCOLParticle.cpp.

int SO3ParticleSystemSetPause

(

mmachine

m

)

SO3ParticleSystemSetPause : Set the pause state for particle system.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: boolean for play/pause

Returns:

I : 1 if success , NIL otherwise

Definition at line 244 of file SCOLParticle.cpp.

int SO3ParticleSystemSetSpeedFactor

(

mmachine

m

)

SO3ParticleSystemSetSpeedFactor : Set the speed factor for particle system.

Prototype: fun [SO3_OBJECT F] I

Parameters:

	SO3_OBJECT	: current node
	F	: speed factor

Returns:

I : 1 if success , NIL otherwise

Definition at line 335 of file SCOLParticle.cpp.