This is an old revision of the document!
Table of Contents
AddParticle
Summary
This function allows you to create a particle effect asset in one of three types: liquid, solid or gas. The particle effect will show up in the ARDI Virtual Environment with appropriate graphical representation according to the particle type chosen.
The newly added particle effect can be associated and maniplulated like any other asset in the virtual environment.
Parameters
Target
Type: Text Default: None
This parameter allows you to specify another asset in the Virtual Environment to parent the particle effect to. If specified, the position parameter will be converted to local coordinates based on the parent.
ParticleType
Type: Text Default: None
This parameter specifies the type of particle effect to be added. Please specify one of the following particle types:
| Particle Type | Meaning |
|---|---|
| Particle_Liquid | Creates a particle emitter that emits drops of liquid. |
| Particle_Gas | Crates a particle emitter that emanates smoke or gas. |
| Particle_Solid | Creates a particle emitter that emits pieces of rock. |
Position
Type: XYZ Coordinates Default: 0,0,0
The co-ordinates in which to place the asset within the 3D world. Co-ordinates are defined as “x,y,z”, separated by a ',' and no spaces.
Rotation
Type: XYZ Coordinates Default: 0,0,0
This parameter allows you to rotate the particle effect by a set of XYZ Coordinates values.
Scale
Type: XYZ Coordinates Default: 1,1,1
This parameter allows you to scale the particle effect by a set of XYZ Coordinates values.
Color
Type: RGB Default: 1,1,1
This parameter sets the color of the new asset. Color must be defined as “r,g,b” using normalized values (values ranging from 0.0 to 1.0)
| Parameter | Meaning |
|---|---|
| r | The value for the amount of red to be applied. Must be a value ranging from 0.0 to 1.0 |
| g | The value for the amount of green to be applied. Must be a value ranging from 0.0 to 1.0 |
| b | The value for the amount of blue to be applied. Must be a value ranging from 0.0 to 1.0 |