< GeeXLab Reference Guide />
> Back to Reference Guide Index
gh_ps library
Description
gh_ps is the module that manages particle systems.
Number of functions: 11
- gh_ps.action_set_gravity ()
- gh_ps.create ()
- gh_ps.create_action_gravity ()
- gh_ps.create_emitter_point ()
- gh_ps.emitter_set_particle_rate_and_speed ()
- gh_ps.emitter_set_spawn_directions ()
- gh_ps.get_num_alive_particles ()
- gh_ps.process_particle_actions ()
- gh_ps.process_particle_emitters ()
- gh_ps.process_particles ()
- gh_ps.update_particles_lifetime ()
action_set_gravity
Description
Sets the gravity vector of an gravity action.
Syntax
gh_ps.action_set_gravity(
action_id,
x, y, z
)
Languages
Parameters
- action_id [ID]: action identifier
- x, y, z [REAL]: gravity vector
Return Values
This function has no return value(s).
Code sample
gh_ps.action_set_gravity(action_id, 0, -9.81, 0)
create
Description
Creates a particle system.
Syntax
ps_id = gh_ps.create(
max_particles,
lifetime
)
Languages
Parameters
- max_particles [INTEGER]: max number of particles
- lifetime [REAL]: max life time of particles
Return Values
- ps_id [ID]: particle system identifier
Code sample
ps_id = gh_ps.create(1000, 2.0)
create_action_gravity
Description
Creates a gravity action.
Syntax
action_id = gh_ps.create_action_gravity(
ps_id
)
Languages
Parameters
- ps_id [ID]: particle system identifier
Return Values
- action_id [ID]: action identifier
Code sample
action_id = gh_ps.create_action_gravity(ps_id)
create_emitter_point
Description
Creates a point emitter.
Syntax
emitter_id = gh_ps.create_emitter_point(
ps_id
)
Languages
Parameters
- ps_id [ID]: particle system identifier
Return Values
- emitter_id [ID]: emitter identifier
Code sample
emitter_id = gh_ps.create_emitter_point(ps_id)
emitter_set_particle_rate_and_speed
Description
Sets the particle rate and the particle speed for a particular emitter.
Syntax
gh_ps.emitter_set_particle_rate_and_speed(
emitter_id,
rate, speed
)
Languages
Parameters
- emitter_id [ID]: emitter identifier
- rate, speed [REAL]: rate and particle speed
Return Values
This function has no return value(s).
Code sample
gh_ps.emitter_set_particle_rate_and_speed(emitter_id, 100, 4.0)
emitter_set_spawn_directions
Description
Sets the particle spawn directions for a particular emitter.
Syntax
gh_ps.emitter_set_spawn_directions(
emitter_id,
x1, y1, z1,
x2, y2, z2
)
Languages
Parameters
- emitter_id [ID]: emitter identifier
- x1, y1, z1 [REAL]: first direction
- x2, y2, z2 [REAL]: second direction
Return Values
This function has no return value(s).
Code sample
gh_ps.emitter_set_spawn_directions(emitter_id, -0.1, 0.5, -0.1, 0.1, 1.0, 0.1)
get_num_alive_particles
Description
Returns the number of alive particles (with lifetime > 0).
Syntax
num_alive = gh_ps.get_num_alive_particles(
ps_id
)
Languages
Parameters
- ps_id [ID]: particle system identifier
Return Values
- num_alive [INTEGER]: number of alive particles
Code sample
n = gh_ps.get_num_alive_particles(ps_id)
process_particle_actions
Description
Processes all particles actions.
Syntax
gh_ps.process_particle_actions(
ps_id,
dt
)
Languages
Parameters
- ps_id [ID]: particle system identifier
- dt [REAL]: time step in seconds
Return Values
This function has no return value(s).
Code sample
gh_ps.process_particle_actions(ps_id, 0.016)
process_particle_emitters
Description
Processes all particles emitters.
Syntax
gh_ps.process_particle_emitters(
ps_id,
dt
)
Languages
Parameters
- ps_id [ID]: particle system identifier
- dt [REAL]: time step in seconds
Return Values
This function has no return value(s).
Code sample
gh_ps.process_particle_emitters(ps_id, 0.016)
process_particles
Description
Processes all particles (run simulation).
Syntax
gh_ps.process_particles(
ps_id,
dt
)
Languages
Parameters
- ps_id [ID]: particle system identifier
- dt [REAL]: time step in seconds
Return Values
This function has no return value(s).
Code sample
gh_ps.process_particles(ps_id, 0.016)
update_particles_lifetime
Description
Updates the particles life time.
Syntax
gh_ps.update_particles_lifetime(
ps_id,
dt
)
Languages
Parameters
- ps_id [ID]: particle system identifier
- dt [REAL]: time step in seconds
Return Values
This function has no return value(s).
Code sample
gh_ps.update_particles_lifetime(ps_id, 0.016)
| |