oZone3D.Net - Demoniak3D Developer Guide

The <particle_system_emitter> node

Function

The particle_system_emitter node describes the object which allows to create and to initialize the particles.

General syntax

<particle_system_emitter
	name=""
	master_object=""
	type="POINT"
	particle_lifetime="5.0"
	particle_speed="30.0"
	particle_rate="50.0"
	emission_type="RADIAL" >
	
	<particle_color
		r="1.0" 
		g="1.0" 
		b="1.0" 
		a="1.0" 
		var_r="0.0" 
		var_g="0.0" 
		var_b="0.0" 
		var_a="0.0" />

	<particle_size
		width="4.0" 
		height="4.0" 
		var_width="0.0" 
		var_height="0.0" />

	<mesh_spawn_point
		x="0.0" 
		y="0.0" 
		z="0.0" />

	<spawn_direction_min
		x="-1.0" 
		y="-1.0" 
		z="-1.0" />

	<spawn_direction_max
		x="1.0" 
		y="1.0" 
		z="1.0" />
		
	<rotation
		angle_z="0.0" 
		var_angle_z="0.0"  />
		
</particle_system_emitter>

particle_system_emitter element

particle_system_emitter is the xml tag that defines a particle_system_emitter node.

Attributes:

name - [STR127] - name of the node. This name will make it possible to refer this node throughout the XML script.
master_object - [STR127] - specifies the object which controls the basic shape of the emitter.
type - [ENUM] - emitter type:
- POINT
- LINE
- SPHERE
- DISC
- MESH
type specifies the type of the emitter, i.e. its basic shape (point, sphere, disc, etc...). This instruction goes hand in hand with the master_object: indeed, characteristics of each emitter type (position, radius, length, etc...) are initialized by the node that describes the object (called in that case the "master-object"): please refer to the mesh and primitive nodes for more information.
particle_lifetime - [REAL] - specifies the life time of a particle in seconds - default value: 5.0
particle_speed - [REAL] - specifies the ejection speed of a particle in units per second - default value: 30.0
particle_rate - [REAL] - specifies the quantity of particles emitted per second - default value: 50.0
emission_type - [ENUM] - specifies how the particles are emitted
- RADIAL: emits the particles in all the directions according to the values of in the spawn_direction_max and spawn_direction_min vectors.
- DIRECTIONNAL: the particles are emitted in a particular direction which is the normal to the master-object's surface (applies mainly to the DISC type emitter).

particle_color element

particle_color specifies the initial color of a the particle. This color will then be able to change depending on the color action.

Attributes:

r - [CLAMPED_REAL] - red component of the color. Float value ranging between 0.0 and 1.0 - default value: 1.0
g - [CLAMPED_REAL] - green component of the color. Float value ranging between 0.0 et 1.0 - default value: 1.0
b - [CLAMPED_REAL] - blue component of the color. Float value ranging between 0.0 and 1.0 - default value: 1.0
a - [CLAMPED_REAL] - alpha component the color. Float value ranging between 0.0 and 1.0 - default value: 1.0
var_r - [CLAMPED_REAL] - variance of the red component. Float value ranging between 0.0 and 1.0 - default value: 0.0
var_g - [CLAMPED_REAL] - variance of the green component. Float value ranging between 0.0 and 1.0 - default value: 0.0
var_b - [CLAMPED_REAL] - variance of the blue component. Float value ranging between 0.0 and 1.0 - default value: 0.0
var_a - [CLAMPED_REAL] - variance of the alpha component. Float value ranging between 0.0 and 1.0 - default value: 0.0

particle_size element

particle_size specifies the initial size of a particle. This size will then be able to change depending on the action size.

Attributes:

width - [REAL] - width of the particle - default value: 4.0
height - [REAL] - height of the particle - default value: 4.0
var_width - [REAL] - width variance - default value: 0.0
var_height - [REAL] - height variance - default value: 0.0

spawn_direction_max element

spawn_direction_max allows to specify the maximum value of the direction vector when initializing particles.

Attributes:

x - [CLAMPED_REAL] - max value of the direction vector's X component - default value: 1.0
y - [CLAMPED_REAL] - max value of the direction vector's Y component - default value: 1.0
z - [CLAMPED_REAL] - max value of the direction vector's Z component - default value: 1.0

spawn_direction_min element

spawn_direction_min allows to specify the minimal value of the direction vector when initializing the particles.

Attributes:

x - [CLAMPED_REAL] - min value of the direction vector's X component - default value: -1.0
y - [CLAMPED_REAL] - min value of the direction vector's Y component - default value: -1.0
z - [CLAMPED_REAL] - min value of the direction vector's Z component - default value: -1.0

mesh_spawn_point element

mesh_spawn_point allows to specify the position of the point which will define the direction vector with each vertices of a mesh when creating particles for a MESH type emitter.

Attributes:

x - [CLAMPED_REAL] - X coordinate of the position - default value: 0.0
y - [CLAMPED_REAL] - Y coordinate of the position - default value: 0.0
z - [CLAMPED_REAL] - Z coordinate of the position - default value: 0.0

El�ment rotation

rotation allows to specify the angle of rotation of the particle along the Z axis.

Attributs:

angle_z - [REAL] - rotation angle in degrees per seconde - default value: 0.0
var_angle_z - [REAL] - variance of the rotation angle in degrees per seconde - default value: 0.0