To do:

Documentation for the Particle System API

By David K. McAllister

davemc@cs.unc.edu

Version 1.10

December 22, 1998

Introduction

The Particle System Application Programmer Interface (API) is a set of functions that allow C++ programs to simulate the dynamics of particles. The Particle System API is intended for special effects in interactive and non-interactive graphics applications, not for scientific simulation, although principles of Newtonian physics have been used to implement the particle dynamics where applicable. The style of the API is intended to be similar to that of OpenGL (from Silicon Graphics, Inc. and the OpenGL Architecture Review Board). OpenGL is currently the standard 3D graphics API because of its cleanness, clarity, and ability to represent a variety of graphics hardware while completely abstracting the hardware away from the application programmer.

This API consists of four sets of functions. These are calls that set the current state of the library, calls that act on groups of particles (these functions are called Actions), calls that operate on and manage particle groups, and calls that create and operate on action lists. The documentation is divided into four sections for the four kinds of functions.

Particles

For the purposes of the Particle System API, a particle is not just a very tiny speck. Particles can be drawn as anything - water droplets, birds, tumbleweeds, even people. The Particle System API is generally useful for operating on many similar objects that all move and change according to the same basic rules, no matter what the objects and rules are.

A particle in the abstract sense used by the API is merely an entity with a small set of attributes such as position and color that ultimately dictate the particle's behavior and appearance. Here are the particle attributes: The position, represented as three floats, tells where the particle is. The color is represented as three floats. The velocity consists of three floats telling the direction and speed of the particle's movement. The size is one float representing how large the particle is for purposes of drawing. At present, the size attribute does not affect the particle's behavior (under gravity, for example), and should not be interpreted as mass in particle physics equations. The age attribute is one float representing the amount of time since the particle's creation. The secondary position, or positionB attribute, specifies another position in space for this particle. It usually represents the particle's initial position, or the particle's destination. See pRestore for a use of positionB.

Particle Groups

A particle group is a system of particles that are all acted on together.

It can be considered a dynamic geometric object.

The dynamics are provided by the particle actions. From the point of view of the graphics system, a particle group is just another model to be drawn. The Particle Groups section of the documentation explains the functions that create and deal with particle groups.

State

As in OpenGL, some calls actually do something and some calls modify the current settings (the current state) that describe the behavior of the calls that do something. Each of the following calls modifies the current state of the Particle System API. Most elements of the current state are used to specify attributes of particles to be created.

Actions

Actions are the core of the Particle System API. They are the functions in the API that directly manipulate the state of particles in particle groups. They perform effects such as gravity, explosions, bouncing, etc. to all particles in the current particle group. A program typically creates and initializes one or more particle groups, then at run time it calls particle actions to animate the particles and finally calls a pDrawGroup function to draw the group of particles onto the screen.

The Particle System API uses a discrete time approximation to all actions. See pTimeStep for information on improving simulation quality by varying the time step, dt.

Action Lists

Action lists are blocks of actions that are applied together to a particle group. They are conceptually similar to scripts or procedures. They can also be thought of as similar to display lists in OpenGL. An action list abstracts the specifics of a particular effect and allows complex effects to be treated as primitives like actions (except that an action list cannot be an action within another action list). Action lists also allow effects to be simulated much more efficiently on certain parallel machines, such as PixelFlow. Also, action lists can be optimized by a particular implementation of the Particle System API. For example, common sequences of actions can be detected and replaced by efficient code that handles all those actions in one pass.

Domains

A Domain is a representation of a region of space. For example, the pSource action uses a domain to describe the volume in which a particle's random initial position will be. The pSink and pBounce actions use domains to describe a volume in space for particles to die when they enter, or to bounce off, respectively. Domains are used as parameters to many functions within the API. See the Domains section of this document for more.

NOTES

Many functions in the Particle System API take arguments with default values. This is a feature of C++ that may be new to many people. For example, in pSize(float s1, float s2 = -1.0), the parameter s2 has a default value of -1.0. This means that pSize can be called with either one parameter or two. When called with two, the parameters are the values for s1 and s2. When called with one parameter, it is the value of s1. The value of s2 in such a function call is the default value, -1.0. Only parameters starting with the right-hand end of the parameter list can have default values specified. Likewise, when calling functions that have default values for parameters at the end of the list, all values specified will be applied to parameters starting with the left. This means that there is no way to specify a value for a parameter at the end of the list without specifying values for all parameters to its left.

State Setting Calls

This is a description of all calls that set the current state of the Particle System API. These state values dictate the properties of particles to be created by pSource or pVertex. The one exception is pTimeStep.

NOTES

When particles are created within a pNewActionList / pEndActionList block, they will receive attributes from the state that was current when the action list was created. When in immediate mode (not creating or calling an action list), particles are created with attributes from the current state.

The initial color domain, modifiable by pColor, is: PDPoint, 1.0, 1.0, 1.0, that is, white. The initial alpha value is 1.0.

The initial velocity domain, modifiable by pVelocity, is: PDPoint, 0.0, 0.0, 0.0, or no velocity.

The initial positionB domain, modifiable by pVertexB, is: PDPoint, 0.0, 0.0, 0.0, however positionB is initially set to track particle position.

The initial size range, modifiable by pSize, is 1.0 to 1.0.

The initial starting age, modifiable by pStartingAge, is 0.0.

void pColor(float red, float green, float blue, float alpha = 1.0f)

Specify the color of new particles.

NOTES

See the documentation of Domains for a discussion of color spaces in the Particle System API.

If rendering is to be done by a method other than the pDrawGroup calls, the particle color does not necessarily need to be used to represent color. It can be interpreted as an arbitrary 3 vector.

void pColorD(float alpha, PDomainEnum dtype, float a0=0.0f, float a1=0.0f, float a2=0.0f, float a3=0.0f, float a4=0.0f, float a5=0.0f, float a6=0.0f, float a7=0.0f, float a8=0.0f)

Specify the color domain of new particles.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pSize(float s1, float s2 = -1.0)

Specify the size range of new particles.

The special value of s2, -1.0, means to set s2 equal to s1. Since the default value of s2 is –1.0, this makes it possible to set the size of particles to an exact value instead of a range by specifying only a single parameter.

void pStartingAge(float age)

Specify the initial age of new particles.

This value can be positive, zero, or negative.

void pTimeStep(float newDT)

Specify the time step length.

The Particle System API uses a discrete time approximation to all actions. This means that actions are applied to the particles at a particular instant in time as if the action's effect accumulated over a small time interval, dt, with the world being constant over the interval. The clock is then "ticked" by the length of the interval and the actions can then be reapplied with the particles having their updated values. This is the standard method of doing almost all time-varying simulations in computer science.

How does the time step, dt, relate to the application's frame rate? The easiest method is to apply the actions once per frame. If the application prefers to keep time in terms of seconds, dt can be set to (1 / frames_per_second). But more often, it is easier for a time unit to be one frame instead of one second. In this case, dt should be 1.0, which is the default.

For higher quality, the application can apply particle actions more than once per frame. This provides smoother, more realistic results in many subtle ways. Suppose the application wanted to compute three animation steps for each rendered frame. Set dt to 1/3 its previous value using pTimeStep, then loop three times over all the action code that gets executed per frame, including the calls to pMove. If using action lists, this can be simply a loop over the pCallActionList call. The run-time results should be about the same, but with fewer discrete approximation artifacts. Surprisingly enough, the actions themselves usually take a small percentage of the CPU time, so using a finer step size usually does not impact frame rate very much.

In terms of numerical integration, particle actions can be thought of as the first derivative of unknown functions dictating the particle attributes over time. In order to compute the particle attributes, these derivative functions must be integrated. Since closed form integration doesn't make sense for most actions, Euler's method is used instead. Euler's method is simply the method just described - the evaluation of the derivative functions at a particular time and then incrementing the current particle values by these derivative results times dt. In Euler's method, the smaller the dt, the more accurate the results.

NOTES

Unlike with other state setting calls, action lists execute using the current dt value set by pTimeStep, rather than the time step value that was current when the action list was created. Making action lists independent of time step size allows the time step to be changed without recompiling the action list.

void pVelocity(float x, float y, float z)

Specify the initial velocity of new particles.

This is shorthand for pVelocityD(PDPoint, x, y, z).

void pVelocityD(PDomainEnum dtype, float a0=0.0f, float a1=0.0f, float a2=0.0f, float a3=0.0f, float a4=0.0f, float a5=0.0f, float a6=0.0f, float a7=0.0f, float a8=0.0f)

Specify the initial velocity domain of new particles.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pVertexB(float x, float y, float z)

Specify the secondary position of new particles.

This is shorthand for pVertexBD(PDPoint, x, y, z).

void pVertexBD(PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Specify the secondary position domain of new particles.

Set the domain from which the positionB of each particle will be randomly chosen when it is created. But if pVertexBTracks is set to true (the default), then the positionB will instead be the same as the initial particle position.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pVertexBTracks(bool doCopy)

Specify how the secondary position of each new particle is chosen.

Specify how the positionB of each new particle emitted will be chosen. The positionB is the destination position or initial position of particles. See pRestore for a use of positionB.

If doCopy is true then when a particle is created its positionB will be the same as its initial particle position (the default).

If doCopy is false then when a particle is created its positionB will be chosen from the VertexB domain.

Actions

Actions modify the position, color, velocity, size, age, and secondary position of particles. All actions apply to the current particle group, as set by pCurrentGroup.

Remember that the amount of effect of an action call depends on the time step size, dt, as set by pTimeStep. See pTimeStep for an explanation of time steps.

NOTES

Some functions have parameters with a default value of P_EPS. P_EPS is a very small floating point constant that is most often used as the default value of the epsilon parameter to actions that accelerate particles relative to the inverse square of their distance from something. If that distance is very small, the amount of acceleration is very big. Since all actions are computed using Euler's method, this can cause unsatisfying results in which particles are accelerated way too much. So this epsilon parameter is added to the distance before taking its inverse square, thus keeping the acceleration within reasonable limits. By varying epsilon, you specify what is reasonable. Larger epsilon make particles accelerate less.

void pBounce(float friction, float resilience, float cutoff, PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Bounce particles off a domain of space.

Particles are tested to see whether they will pass from being outside the specified domain to being inside it if the next pMove action were to occur now. If they would pass through the surface of the domain, they are instead bounced off it. That is, their velocity vector is decomposed into components normal to the surface and tangent to the surface. The direction of the normal component is reversed, and the components are recomposed into a new velocity heading away from the surface.

The normal component is multiplied by the resilience parameter and the tangential component, if its magnitude is greater than cutoff, is multiplied by (1 - the friction parameter) when being composed into the new velocity vector.

The cutoff parameter can allow particles to glide smoothly along a surface without sticking.

NOTES

Since particles are tested to see whether they would pass through the domain if pMove were called now, it is best to have pBounce be the last action that modifies a particle's velocity before calling pMove. Also, actions such as pRandomDisplace and pVortex that modify a particle's position directly, rather than modifying its velocity vector, may yield unsatisfying results when used with pBounce.

At present the only domains for which pBounce is implemented are PDSphere, PDTriangle and PDPlane. For spheres, the particle is always forced out of the sphere. For triangles, the particles bounce off either side of the triangle. For planes, particles bounce off either side of the diamond-shaped patch whose corners are o, o+u, o+u+v, and o+v. See the documentation on domains for an explanation.

See the documentation of Domains for an explanation of the other arguments.

pBounce

doesn't work correctly with small time step sizes for particle sliding along a surface. The friction and resilience parameters should not be scaled by dt, since a bounce happens instantaneously. On the other hand, they should be scaled by dt because particles sliding along a surface will hit more often if dt is smaller. If you have any suggestions, let me know.

void pCopyVertexB(bool copy_pos = true, bool copy_vel = false)

Set the secondary position from current position.

If copy_pos is true, sets the positionB of each particle in the current particle group to be equal to the current position of that particle. This makes each particle "remember" this position so it can later return to it using pRestore. If copy_vel is true, sets the velocityB of each particle in the current particle group to be equal to the current velocity of that particle. This is useful for computing the orientation of the particle when rendering it using pDrawGroupl.

void pDamping(float damping_x, float damping_y, float damping_z, float vlow = 0.0f, float vhigh = P_MAXFLOAT)

Simulate air by slowing down particle velocities.

If a particle's velocity magnitude is within vlow and vhigh, then multiply each component of the velocity by the respective damping constant. Typically, the three components of damping will have the same value.

NOTES

There are no bounds on the damping constants. Thus, by giving values greater than 1.0 they may be used to speed up particles in stead of slow them down.

void pExplosion(float center_x, float center_y, float center_z, float velocity, float magnitude, float lifetime, float epsilon = P_EPS, float age = 0.0f)

An Explosion.

Causes an explosion by accelerating all particles away from the center. Particles in the shock wave are accelerated away from the center by an amount proportional to magnitude. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

The shock wave of the explosion travels outward from the center at the specified velocity. The shock wave has a thickness of lifetime, which is the amount of time for which the shock wave will affect any piece of space.

age

is used to calculate the radius of the shock wave. For pExplosion calls in action lists, age is the initial age of the explosion. It is incremented by dt after each call. For immediate mode, age is the current age of the explosion, and it is up to the application to increment the age parameter for each call to pExlosion.

void pFollow(float grav = 1.0f, float epsilon = P_EPS)

Accelerate toward the next particle in the group.

This allows snaky effects where the particles follow each other. Each particle is accelerated toward the next particle in the group by an amount proportional to grav. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

NOTES

The pFollow action does not affect the last particle in the group. This allows controlled effects where the last particle in the group is killed after each time step and replaced by a new particle at a slightly different position. See pKillOld to learn how to kill the last particle in the group after each step.

void pGravitate(float grav = 1.0f, float epsilon = P_EPS)

Accelerate each particle toward each other particle.

Each particle is accelerated toward each other particle in the group by an amount proportional to grav. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

NOTES

This action is more computationally intensive than the others are because each particle is affected by each other particle.

This action can cause particles to conform to a certain shape. Define the shape using a few particles as control points. Place them in particular locations and keep them there each frame by killing them with pKillOld and replacing them with pVertex. See pKillOld to learn how to kill the last particles in the group after each step.

void pGravity(float dir_x, float dir_y, float dir_z)

Accelerate particles in the given direction.

The gravity acceleration vector is simply added to the velocity vector of each particle at each time step. The magnitude of the gravity vector is the acceleration due to gravity. For example, pGravity(0, 0, -9.8) specifies gravity in the negative Z direction.

void pJet(float center_x, float center_y, float center_z, float grav = 1.0f, float epsilon = P_EPS, float maxRadius = P_MAXFLOAT)

Accelerate particles that are near the center of the jet.

For each particle, chooses an acceleration vector from the domain and applies it to the particle's velocity. The amount of acceleration applied is directly proportional to grav. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

The domain from which acceleration vectors are chosen is the current velocity domain.

maxRadius

defines the sphere of influence of this action. No particle further than maxRadius from the center is affected.

void pKillOld(float ageLimit, bool kill_less_than = false)

Remove old particles.

Removes all particles older than ageLimit. But if kill_less_than is true, it instead removes all particles newer than ageLimit. ageLimit is not clamped, so negative values are ok. This can be used in conjunction with pStartingAge(-n) to create and then kill a particular set of particles.

NOTES

In order to kill a particular particle, set pStartingAge to a number that will never be a typical age for any other particle in the group, for example -10.0. Then emit the particle using pSource or pVertex. Then do the rest of the particle actions and finally call pKillOld(-8.0, true) to kill the special particle because it is the only one with an age less than -8.0.

void pKillSlow(float speedLimit, bool kill_less_than = true)

Remove slow particles.

Removes all particles whose velocity magnitudes are less than speedLimit. But if kill_less_than is false, it instead removes all particles whose velocity magnitudes are faster than speedLimit.

NOTES

This action is similar to pSinkVelocity, but it considers the magnitude of the velocity only.

void pMove()

Move particle positions based on velocities.

This action actually updates the particle positions by adding the current velocity to the current position. This is typically the last particle action performed in an iteration of a particle simulation, and typically only occurs once per action list.

The velocity is multiplied by the time step length, dt, before being added to the position. This implements Euler's method of numerical integration with a constant, but specifiable step size. See pTimeStep for more on varying the step size.

void pOrbitLine(float p_x, float p_y, float p_z, float axis_x, float axis_y, float axis_z, float grav = 1.0f, float epsilon = P_EPS, float maxRadius = P_MAXFLOAT)

Accelerate toward the closest point on the given line.

p

and axis define an infinite line, where p can be any point on the line and axis is any vector parallel to the line. For each particle, this action computes the vector to the closest point on the line, and accelerates the particle in the vector direction. The amount of acceleration applied is directly proportional to grav. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

maxRadius

defines the infinite cylinder of influence of this action. No particle further than maxRadius from the line is affected.

void pOrbitPoint(float center_x, float center_y, float center_z, float grav = 1.0f, float epsilon = P_EPS, float maxRadius = P_MAXFLOAT)

Accelerate toward the given center point.

For each particle, this action computes the vector to the center point, and accelerates the particle in the vector direction. The amount of acceleration applied is directly proportional to grav. As with most acceleration actions, the amount of acceleration falls off inversely with (r^2). But when r is small, the acceleration would be infinite, so epsilon is always added to r.

maxRadius

defines the sphere of influence of this action. No particle further than maxRadius from the center is affected.

void pRandomAccel(PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Accelerate particles in random directions.

For each particle, chooses an acceleration vector from the specified domain and adds it to the particle's velocity.

Reducing the time step, dt, will make a higher probability of being near the original velocity after unit time. Smaller dt approach a normal distribution of velocity vectors instead of a square wave distribution.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pRandomDisplace(PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Immediately displace particle positions.

For each particle, chooses a displacement vector from the specified domain and adds it to the particle's position.

Reducing the time step, dt, will make a higher probability of being near the original position after unit time. Smaller dt approach a normal distribution of particle positions instead of a square wave distribution.

NOTES

Since this action moves particle positions, unsatisfying results may occur when used with the pBounce action. In particular, particles may be displaced to the opposite side of the bounce surface without bouncing off it.

See the documentation of Domains for an explanation of the other arguments.

void pRandomVelocity(PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Immediately assign a random velocity.

For each particle, sets the particle's velocity vector to a random vector in the specified domain.

This function is not affected by dt. If you can think of an appropriate way for this to vary with dt, let me know.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pRestore(float timeLeft)

Over time, restore particles to their secondary positions.

Computes a new velocity for each particle that will make the particle arrive at its positionB at the specified amount of time in the future. The curved path that the particles take is a parametric quadratic. Once the specified amount of time has passed, the particles are clamped to their positionB and their velocities are set to 0 to freeze them in place.

If pRestore is called in immediate mode, it is the application's responsibility to decrease timeLeft by dt on each call. When in an action list, timeLeft gets decremented automatically.

The positionB attribute of each particle is typically the particle's position when it was created, or it can be specified within a domain. This is controlled by pVertexBTracks, pVertexB, and pVertexBD. The positionB can be set at any time to the particle's current position using the pCopyVertexB action.

NOTES

pRestore

(0) is the opposite of pCopyVertexB - it sets each particle's position to be equal to its positionB. However, this has the side effect of setting each particle's velocity to 0.

void pSink(bool kill_inside, PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Kill particles with positions on wrong side of the specified domain.

If kill_inside is true, deletes all particles inside the given domain. If kill_inside is false, deletes all particles outside the given domain.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pSinkVelocity(bool kill_inside, PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Kill particles with velocities on wrong side of the specified domain.

If kill_inside is true, deletes all particles whose velocity vectors are inside the given domain. If kill_inside is false, deletes all particles whose velocity vectors are outside the given domain.

NOTES

See the documentation of Domains for an explanation of the other arguments.

void pSource(float particleRate, PDomainEnum dtype, float a0 = 0.0f, float a1 = 0.0f, float a2 = 0.0f, float a3 = 0.0f, float a4 = 0.0f, float a5 = 0.0f, float a6 = 0.0f, float a7 = 0.0f, float a8 = 0.0f)

Add particles in the specified domain.

Adds new particles to the current particle group. The particle positions are chosen from the given domain. The particle colors, sizes, initial ages, velocities, and secondary positions are chosen according to their current domains. See pColor, pColorD, pSize, pStartingAge, pVelocity, pVelocityD, pVertexB, pVertexBD, and pVertexBTracks.

When pSource is called within an action list, the particle attribute domains used are those that were current when the pSource command was called within the pNewActionList / pEndActionList block instead of when pCallActionList is called. Note that this is unlike OpenGL.

particleRate

is the number of particles to add per unit time. If particleRate / dt is a fraction then pSource adjusts the number of particles to add during this time step so that the average number added per unit time is particleRate.

NOTES

If too few particles seem to be added each frame, it is probably because the particle group is already full. If this is bad, you can grow the group using pSetMaxParticles.

See the documentation of Domains for an explanation of the other arguments.

void pTargetColor(float color_x, float color_y, float color_z, float alpha, float scale)

Change color of all particles toward the specified color.

Modifies the color and alpha of each particle to be scale percent of the way closer to the specified color and alpha. scale is multiplied by dt before scaling the sizes. Thus, using smaller dt causes a slightly faster approach to the target color.

NOTES

This action makes all colors tend toward the specified, uniform color. Future versions will have more actions that modify color. Please send me suggestions (perhaps with sample implementations).

void pTargetSize(float destSize, float scale)

Gradually grow particle sizes toward specified size.

Modifies the size of each particle to be scale percent of the way closer to the specified destSize. This makes sizes grow asymptotically closer to the given size. scale is multiplied by dt before scaling the sizes. Thus, using smaller dt causes a slightly faster approach to the target size.

NOTES

This action makes all sizes tend toward the specified, uniform size. Future versions will have more actions that modify size. Please send me suggestions (perhaps with sample implementations).

void pVertex(float x, float y, float z)

Add a single particle at the specified location.

When called within a pNewActionList / pEndActionList block, this action is a shorthand for:

pSource

(1, PDPoint, x, y, z).

However, when called in immediate mode, this action uses a slightly faster method to add a single particle to the current particle group. Also, when in immediate mode, exactly one particle will be added per call, instead of an average of 1 / dt particles being added. Particle attributes are chosen according to their current domains, as with pSource.

NOTES

This call is patterned after the glVertex calls. It is useful for creating a particle group with exactly specified initial positions. For example, you can specify a geometrical model using pVertex calls, and then explode or deform it.

void pVortex(float center_x, float center_y, float center_z, float axis_x, float axis_y, float axis_z, float magnitude, float tightness = 1.0f, float maxRadius = P_MAXFLOAT)

Swirl particles around a vortex.

center

and axis define an infinite line, where center represents the tip of the vortex and axis is any vector parallel to the line. All particles are rotated about the line by an amount theta = magnitude / (r^tightness), where r is the distance from the vortex tip to the particle, so particles closer to the tip are rotated faster.

maxRadius

defines the sphere of influence of this action. No particle further than maxRadius from the vortex center is affected.

NOTES

pVortex immediately displaces particle positions, unlike most actions which affect particle velocities, so unsatisfying results may occur when using the pVortex action with the pBounce action. In particular, particles may be displaced to the opposite side of the bounce surface without bouncing off it.

pVortex

currently does not pull the particles toward the axis or pull them up or down along the axis. This will be saved for a future release. If you write a sample implementation of these features, feel free to send it to me.

Particle Group Calls

A particle group is first created using pGenParticleGroups, which will return the identifying number of the generated particle group. Unless otherwise specified, all other commands operate on the current particle group. You specify which group is current using pCurrentGroup. The maximum number of particles in the group is specified using pSetMaxParticles. The particle group is then acted upon using the functions listed in the Actions. Some actions will add particles to the particle group, and others will modify the particles in other ways. Typically, a series of actions will be applied to each particle group once (or more) per rendered frame. The particles are then actually drawn. This is similar to the process of rendering a display list in OpenGL, and should be done at the same stage of the application's execution as drawing geometry. To draw a particle group in OpenGL, the application calls one of the pDrawGroup functions. Alternatively, the application can get a copy of the particle data using pGetParticles and use it for other rendering or processing methods. When a particle group is no longer needed, it is deleted using pDeleteParticleGroups.

void pCopyGroup(int p_group_num, int index = 0, int copy_count = P_MAXINT)

Copy particles from the specified group into the current group.

Copy particles from the specified particle group, p_group_num, to the current particle group. Only copy_count particles, starting with number index are copied. Of course, the number of particles actually copied is bounded by the available space in the current particle group, and the number of particles actually in the source particle group. The particles are added in order to the end of the current group. index is the index of the first particle in the source particle group to be copied.

void pCurrentGroup(int p_group_num)

Change which group is current.

Makes p_group_num be the current particle group to which all actions and commands apply.

void pDeleteParticleGroups(int p_group_num, int p_group_count)

Delete one or more consecutive particle groups.

Deletes p_group_count particle groups, with p_group_num being the particle group number of the first one. The groups must be numbered sequentially, and must all exist. This removes the specified particle groups from existence. It does not merely change the number of existing particles or the maximum size of the group.

void pDrawGroupl(int dlist, bool const_size = false, bool const_color = false, bool const_rotation = false)

Draw each particle as a model using OpenGL display lists.

Calls the given OpenGL display list, dlist, once for each particle in the particle group. The display list typically contains only geometry (glBegin / glEnd blocks). Before the display list is drawn for each particle, the OpenGL state is changed. First, the display list is translated to the particle's position. Next, if const_size is false, the matrix stack is modified to scale the display list by the particle's size. Then, if const_rotation is false, the matrix is rotated so that the display list's positive X axis points in the direction of the particle's velocity vector. Finally, if const_color is false, the OpenGL current color is set to the particle's color. If const_color is true, then the OpenGL current color is set only once before drawing any particles. If const_size is true, then no scaling is ever done. If const_rotation is true then no rotation is ever done. This is useful for symmetrical models such as spheres.

NOTES

The OpenGL current color is left in an undefined state following a call to pDrawGroupl.

This command operates on the OpenGL matrix stack, but does not change the matrix mode. It is the application's responsibility to ensure that the matrix mode is correct, usually by calling glMatrixMode(GL_MODELVIEW) first.

Models containing multiple colors can be drawn by constructing a display list that first draws the geometry that will be in the particle color, then changes the color (by calling glColor), then draws geometry in the new color. For example, this could be used to draw balloons of many different colors that each have a white string.

Another way to draw particles that allows greater flexibility than pDrawGroupl is for the application to get the particle data using pGetParticles, and then draw it using any desired method.

void pDrawGroupp(int primitive, bool const_size = false, bool const_color = false)

Draw a particle group using OpenGL primitives.

This is the fastest OpenGL-based method of drawing particles. The exact results depend on the OpenGL primitive type specified. When primitive equals GL_POINTS or any value other than GL_LINES, each particle becomes a single vertex in an OpenGL glBegin / glEnd block. For GL_LINES, each particle becomes a line specified by two vertices - the particle's position and the particle's position minus velocity, yielding a line in the direction that the particle is travelling.

NOTES

The OpenGL current color is left in an undefined state following a call to pDrawGroupp.

At present, GL_LINES is the only primitive handled as a special case. If you have suggestions for sensible, general ways to handle other OpenGL primitives, please tell me.

See also pDrawGroupl.

int pGenParticleGroups(int p_group_count = 1, int max_particles = 0)

Create particle groups, each with max_particles allocated.

Generates p_group_count new particle groups and returns the particle group number of the first one. The groups are numbered sequentially, beginning with the number returned. Each particle group is set to have at most max_particles particles. Call pSetMaxParticles to change this.

Particle group numbers of groups that have been deleted (using pDeleteParticleGroups) may be reused by pGenParticleGroups.

int pGetGroupCount()

Returns the number of particles existing in the current group.

What the summary says.

void pGetParticles(int index, int count, float *verts, float *color = NULL, float *vel = NULL, float *size = NULL)

Copy particles from the current group to application memory.

Copies count particles beginning with the index-th particle in the current particle group into application memory.

int pSetMaxParticles(int max_count)

Change the maximum number of particles in the current group.

If necessary, this will delete particles from the end of the particle group, but no other particles will be deleted.

Action List Calls

These calls create and operate on action lists, which are scripts of many actions to be applied together as a block to the current particle group. An action list is first created using pGenActionLists, and is then defined by calling particle action functions between a call to pNewActionList and a call to pEndActionList. Once the action list is created, it is run via pCallActionList. Thus, an action list is sort of a higher-level action. Complex behaviors can be stored in an action list and then called later, even as part of another action list. Action lists cannot be edited. They can only be created or destroyed. To destroy an action list, call pDeleteActionLists.

NOTES

When particles are created within a pNewActionList / pEndActionList block, they will receive attributes from the state that was current when the action list was created. When in immediate mode (not creating or calling an action list), particles are created with attributes from the current state.

The time step length, dt, uses the value that is current when pCallActionList is executed, not the value of dt when the action list was created. This allows dt to be modified without recompiling action lists. Maybe this isn't a good idea. If it should be the other way in the future, let me know.

void pCallActionList(int action_list_num)

Apply the specified action list to the current particle group.

void pDeleteActionLists(int action_list_num, int action_list_count = 1)

Delete one or more consecutive action lists.

Deletes action_list_count action lists, with action_list_num being the list number of the first one. The lists must be numbered sequentially, and must all exist. This removes the specified action lists from existence.

void pEndActionList()

End the creation of a new action list.

int pGenActionLists(int action_list_count = 1)

Generate empty action lists.

void pNewActionList(int action_list_num)

Begin the creation of the specified action list.

NOTES

If called on an action list that has previously been defined, the previous contents of the action list are destroyed and the action list will be created anew. This is as with glNewList in OpenGL.

Domains

A Domain is a representation of a region of space. For example, the pSource action uses a domain to describe the volume in which a particle will be created. A random point within the domain is chosen as the initial position of the particle. The pSink and pBounce actions use domains to describe a volume in space for particles to die when they enter, or to bounce off, respectively.

Domains are also used to describe velocities. Picture the velocity vector as having its tail at the origin and its tip being in the domain.

Finally, domains can be used to describe colors. For drawing with OpenGL, the full color space is 0.0 -> 1.0 in the red, green, and blue axes. For example, the domain PDLine, 1, 0, 0, 1, 1, 0 will choose points on a line between red and yellow. Points outside the 0.0 -> 1.0 range will not be clamped, but eventually will be clamped deep within the OpenGL pipeline.

Since data from particle systems can be used by more than just the OpenGL renderer, the floating point triple used for color can mean different things to different consumers of the data. For example, if a software renderer used colors on the range 0 -> 255, the domain used to choose the colors can be on that range. The color space does not even need to be thought of as RGB, but will be for use in OpenGL.

Several types of domains can be specified. The two basic abstract operations on a domain are Generate, which returns a random point in the domain, and Within, which tells whether a given point is within the domain. Functions such as pSource that take a domain as an argument take it in the form of a PDomainEnum, followed by nine floats. The PDomainEnum is one of the symbolic constants listed below, such as PDPoint. The nine floats mean different things for each type of domain, as described below. Not all domains require all nine floats. You only need to specify the first few values that are relevant to that domain type.

PDPoint

x, y, z

This domain is a single point.

Generate

always returns this point. Within always returns false.

PDLine

x1, y1, z1, x2, y2, z2

These are the endpoints of a line segment.

Generate

returns a random point on this segment. Within always returns false.

PDTriangle

x0, y0, z0, x1, y1, z1, x2, y2, z2

These are the vertices of a triangle. The triangle can be used to define an arbitrary geometrical model and bounce particles off it, generate particles on its surface (and explode them), etc.

Generate

returns a random point in the triangle. Within always returns false. [This must eventually change so we can sink particles that enter/exit a model. Suggestions?]

PDPlane

ox, oy, oz, ux, uy, uz, vx, vy, vz

The point o is a point on the plane. u and v are (non-parallel) basis vectors in the plane. They don't need to be normal or orthogonal.

Generate

returns a random point in the diamond-shaped patch whose corners are o, o+u, o+u+v, and o+v. Within returns true if the point is in the positive half-space of the plane (in the plane or on the side that the normal (u cross v) points to).

PDBox

x1, y1, z1, x2, y2, z2

These are the minima and maxima of an axis-aligned box. It doesn't matter which of each coordinate is min and which is max.

Generate

returns a random point in this box. Within returns true if the point is in the box.

PDSphere

ox, oy, oz, radius1, radius2 = 0.0

The point o is the center of the sphere. radius1 is the outer radius of the shell and radius2 is the inner radius.

Generate

returns a random point in the thick shell at a distance between radius1 to radius2 from point o. If radius2 is 0, then it is the whole sphere. Within returns true if the point lies within the thick shell at a distance between radius1 to radius2 from point o.

PDCylinder

x1, y1, z1, x2, y2, z2, radius1, radius2 = 0.0

The two points are the endpoints of the axis of the cylinder. radius1 is the outer radius, and radius2 is the inner radius for a cylindrical shell. radius2 = 0 for a solid cylinder with no empty space in the middle.

Generate

returns a random point in the cylindrical shell. Within returns true if the point is within the cylindrical shell.

PDCone

x1, y1, z1, x2, y2, z2, radius1, radius2 = 0.0

The first point is the apex of the cone and the second is the other endpoint of the axis of the cone. radius1 is the radius of the base of the cone. radius2 is the radius of the base of a cone to subtract from the first cone to create a conical shell. This is similar to the cylindrical shell, which can be thought of as a large cylinder with a smaller cylinder subtracted from the middle. Both cones share the same apex and axis, which implies that the thickness of the conical shell tapers to 0 at the apex. radius2 = 0 for a solid cone with no empty space in the middle.

Generate

returns a random point in the conical shell. Within returns true if a point is within the conical shell.

PDBlob

x, y, z, stdev

The point x, y, z is the center of a normal probability density of standard deviation stdev. The density is radially symmetrical. The blob domain allows for some very natural-looking effects because there is no sharp, artificial-looking boundary at the edge of the domain.

Generate

returns a point with normal probability density. Within has a probability of returning true equal to the probability density at the specified point.

Appendix

Acknowledgements

Code for some of the particle actions and several concepts regarding the structure of the API are thanks to Jonathan P. Leech,

ljp@sgi.com. See also:

Jonathan Leech and Russell M. Taylor II, "Interactive Modeling Using Particle Systems", Proceedings of the 2nd Conference on Discrete Element Methods, MIT, spring 1993, pp. 105-116.

Thanks to Mark Allen of NASA Ames Research Center for finding bugs, making suggestions and implementing the particle length attribute.

Thanks to Jason Pratt of CMU Stage 3 research group (makers of ALICE) for adding the PDTriangle domain. This is a powerful feature that should have been there the whole time.

To Do

Add a centralize flag to explosion

For the pspray demo, have it randomly change modes occasionally.

Explosion should not be scaled by dt since it usually hits for only an instant.

Explosion wave should be gaussian instead of square wave.

Test multiple particle groups better.

Resolve issues commented with "XXX".

Change pDraw* const_ to apply_, reverse the sense of it, and make it so if false, color isn’t touched.

Const_size isn’t used in pDrawGroupp.

Add a TOC listing all functions.

Future Versions

The home page of the Particle System API is

http://www.cs.unc.edu/~davemc/Particle Check back occasionally for new versions and other new developments.

Have a secondary color for each particle.

Replace the lifetime parameter of explosions with stdev and make the shock wave be gaussian instead of square. This will fix the ugly quantization effects in explosions of very dense particle clouds.

Obstacle avoidance action – this requires more thinking about object definition. Can this be done with domains?

Interpolate to a given velocity (like color and size interp)

Match velocity to near neighbors

// The above three actions will allow implementation of Craig Reynolds’ Boids algorithm.

pVelocityColor

- color is f( velocity)

pPositionColor

- color is f (position)

pDensityColor

- color is f (density)

pRandomColor

- random domain is added to color

pVelocitySize

- size is f(velocity)