Project

General

Profile

SO3Engine
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

◆ SO3ParticleSystemClear()

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 414 of file SCOLParticle.cpp.

◆ SO3ParticleSystemCreateFromTemplate()

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 52 of file SCOLParticle.cpp.

◆ SO3ParticleSystemGetEnable()

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 196 of file SCOLParticle.cpp.

◆ SO3ParticleSystemGetPause()

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 287 of file SCOLParticle.cpp.

◆ SO3ParticleSystemGetSpeedFactor()

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 374 of file SCOLParticle.cpp.

◆ SO3ParticleSystemGetTemplate()

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 103 of file SCOLParticle.cpp.

◆ SO3ParticleSystemSetEnable()

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 149 of file SCOLParticle.cpp.

◆ SO3ParticleSystemSetPause()

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 241 of file SCOLParticle.cpp.

◆ SO3ParticleSystemSetSpeedFactor()

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 332 of file SCOLParticle.cpp.