yaarq.sys
Class yrqParticleManager

java.lang.Object
  |
  +--yaarq.sys.yrqParticleManager

public class yrqParticleManager
extends java.lang.Object

This class provides parameters for configuring a particle visual. A particle manager creates, updates and removes particles from a particle visual based on parameters set by the user.

Particle visuals are automatically assigned a particle mangager on instantiation, applications do not need to create or manage their own instances of the ParticleManager class. A particle visual is always added to the root frame internally. To allow for particles to be generated at a position synchronized with a yrqFrame instance, the setSourceFrame method is provided. The particle manager takes the source frame position and orientation into account on creating new particles.

TODO: Document parameters, incorporate reference frame direction into generation, increase accuracy of generation count (probabilistic!)


Constructor Summary
yrqParticleManager(yrqParticleVisual a_set)
          Constructs a particlemanager for the given particle visual.
 
Method Summary
 void addForce(java.lang.String a_name, javax.vecmath.Vector3d a_force)
          ...
 boolean getEnable()
          ...
 javax.vecmath.Vector3d getForce(java.lang.String a_name)
          ...
 void removeForce(java.lang.String a_name)
          ...
 void setAlphaFunction(long a_time, float a_value)
          ...
 void setEnable(boolean a_enable)
          ...
 void setFriction(double a_friction)
          ...
 void setGenerationAlpha(double a_value, double a_variation)
          ...
 void setGenerationCount(int a_value, double a_variation)
          ...
 void setGenerationHeading(javax.vecmath.Vector3d a_value, double a_variation)
          ...
 void setGenerationRadius(double a_value, double a_variation)
          ...
 void setGenerationSize(double a_value, double a_variation)
          ...
 void setGenerationSpeed(double a_value, double a_variation)
          ...
 void setSizeFunction(long a_time, double a_value)
          ...
 void update()
          This method is called by the particle visual using this manager to request creation of particles according to set parameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

yrqParticleManager

public yrqParticleManager(yrqParticleVisual a_set)
Constructs a particlemanager for the given particle visual. Do not use this call from applications, particlevisuals instantiate their own managers.

Parameters:
a_set - the Particle visual this manager will manage
Method Detail

addForce

public void addForce(java.lang.String a_name,
                     javax.vecmath.Vector3d a_force)
...


getEnable

public boolean getEnable()
...


getForce

public javax.vecmath.Vector3d getForce(java.lang.String a_name)
...


removeForce

public void removeForce(java.lang.String a_name)
...


setAlphaFunction

public void setAlphaFunction(long a_time,
                             float a_value)
...


setEnable

public void setEnable(boolean a_enable)
...


setFriction

public void setFriction(double a_friction)
...


setGenerationAlpha

public void setGenerationAlpha(double a_value,
                               double a_variation)
...


setGenerationCount

public void setGenerationCount(int a_value,
                               double a_variation)
...


setGenerationHeading

public void setGenerationHeading(javax.vecmath.Vector3d a_value,
                                 double a_variation)
...


setGenerationRadius

public void setGenerationRadius(double a_value,
                                double a_variation)
...


setGenerationSize

public void setGenerationSize(double a_value,
                              double a_variation)
...


setGenerationSpeed

public void setGenerationSpeed(double a_value,
                               double a_variation)
...


setSizeFunction

public void setSizeFunction(long a_time,
                            double a_value)
...


update

public void update()
This method is called by the particle visual using this manager to request creation of particles according to set parameters