OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
osgParticle::Particle Class Reference

Implementation of a particle. More...

Public Types

enum  { INVALID_INDEX = -1 }
 
enum  Shape {
  POINT, QUAD, QUAD_TRIANGLESTRIP, HEXAGON,
  LINE, USER
}
 Shape of particles. More...
 

Public Member Functions

 Particle ()
 
Shape getShape () const
 Get the shape of the particle. More...
 
void setShape (Shape s)
 Set the shape of the particle. More...
 
bool isAlive () const
 Get whether the particle is still alive. More...
 
double getLifeTime () const
 Get the life time of the particle (in seconds). More...
 
double getAge () const
 Get the age of the particle (in seconds). More...
 
const rangefgetSizeRange () const
 Get the minimum and maximum values for polygon size. More...
 
const rangefgetAlphaRange () const
 Get the minimum and maximum values for alpha. More...
 
const rangev4getColorRange () const
 Get the minimum and maximum values for color. More...
 
const InterpolatorgetSizeInterpolator () const
 Get the interpolator for computing the size of polygons. More...
 
const InterpolatorgetAlphaInterpolator () const
 Get the interpolator for computing alpha values. More...
 
const InterpolatorgetColorInterpolator () const
 Get the interpolator for computing color values. More...
 
float getRadius () const
 Get the physical radius of the particle. More...
 
float getMass () const
 Get the mass of the particle. More...
 
float getMassInv () const
 Get 1 / getMass(). More...
 
const osg::Vec3getPosition () const
 Get the position vector. More...
 
const osg::Vec3getVelocity () const
 Get the velocity vector. More...
 
const osg::Vec3getPreviousPosition () const
 Get the previous position (the position before last update). More...
 
const osg::Vec3getAngle () const
 Get the angle vector. More...
 
const osg::Vec3getAngularVelocity () const
 Get the rotational velocity vector. More...
 
const osg::Vec3getPreviousAngle () const
 Get the previous angle vector. More...
 
const osg::Vec4getCurrentColor () const
 Get the current color. More...
 
float getCurrentAlpha () const
 Get the current alpha. More...
 
float getSTexCoord () const
 Get the s texture coordinate of the bottom left of the particle. More...
 
float getTTexCoord () const
 Get the t texture coordinate of the bottom left of the particle. More...
 
int getTileS () const
 Get width of texture tile. More...
 
int getTileT () const
 Get height of texture tile. More...
 
int getNumTiles () const
 Get number of texture tiles. More...
 
void kill ()
 Kill the particle on next update NOTE: after calling this function, the isAlive() method will still return true until the particle is updated again. More...
 
void setLifeTime (double t)
 Set the life time of the particle. More...
 
void setSizeRange (const rangef &r)
 Set the minimum and maximum values for polygon size. More...
 
void setAlphaRange (const rangef &r)
 Set the minimum and maximum values for alpha. More...
 
void setColorRange (const rangev4 &r)
 Set the minimum and maximum values for color. More...
 
void setSizeInterpolator (Interpolator *ri)
 Set the interpolator for computing size values. More...
 
void setAlphaInterpolator (Interpolator *ai)
 Set the interpolator for computing alpha values. More...
 
void setColorInterpolator (Interpolator *ci)
 Set the interpolator for computing color values. More...
 
void setRadius (float r)
 Set the physical radius of the particle. More...
 
void setMass (float m)
 Set the mass of the particle. More...
 
void setPosition (const osg::Vec3 &p)
 Set the position vector. More...
 
void setVelocity (const osg::Vec3 &v)
 Set the velocity vector. More...
 
void addVelocity (const osg::Vec3 &dv)
 Add a vector to the velocity vector. More...
 
void transformPositionVelocity (const osg::Matrix &xform)
 Transform position and velocity vectors by a matrix. More...
 
void transformPositionVelocity (const osg::Matrix &xform1, const osg::Matrix &xform2, float r)
 Transform position and velocity vectors by a combination of two matrices. More...
 
void setAngle (const osg::Vec3 &a)
 Set the angle vector. More...
 
void setAngularVelocity (const osg::Vec3 &v)
 Set the angular velocity vector. More...
 
void addAngularVelocity (const osg::Vec3 &dv)
 Add a vector to the angular velocity vector. More...
 
void transformAngleVelocity (const osg::Matrix &xform)
 Transform angle and angularVelocity vectors by a matrix. More...
 
bool update (double dt, bool onlyTimeStamp)
 Update the particle (don't call this method manually). More...
 
void beginRender (osg::GLBeginEndAdapter *gl) const
 Perform some pre-rendering tasks. Called automatically by particle systems. More...
 
void render (osg::GLBeginEndAdapter *gl, const osg::Vec3 &xpos, const osg::Vec3 &px, const osg::Vec3 &py, float scale=1.0f) const
 Render the particle. Called automatically by particle systems. More...
 
void render (osg::RenderInfo &renderInfo, const osg::Vec3 &xpos, const osg::Vec3 &xrot) const
 Render the particle with user-defined drawable. More...
 
void endRender (osg::GLBeginEndAdapter *gl) const
 Perform some post-rendering tasks. Called automatically by particle systems. More...
 
float getCurrentSize () const
 Get the current (interpolated) polygon size. Valid only after the first call to update(). More...
 
void setTextureTileRange (int sTile, int tTile, int startTile, int endTile)
 Specify how the particle texture is tiled. More...
 
void setTextureTile (int sTile, int tTile, int end=-1)
 Same as above, range starts at 0 and ends at end. More...
 
void setPreviousParticle (int previous)
 Set the previous particle. More...
 
int getPreviousParticle () const
 Get the previous particle. More...
 
void setNextParticle (int next)
 Set the next particle. More...
 
int getNextParticle () const
 Get the const next particle. More...
 
void setDepth (double d)
 Set the depth of the particle. More...
 
double getDepth () const
 Get the depth of the particle. More...
 
void setDrawable (osg::Drawable *d)
 Set the user-defined particle drawable. More...
 
osg::DrawablegetDrawable () const
 Get the user-defined particle drawable. More...
 
bool operator< (const Particle &P) const
 Sorting operator. More...
 
void setUpTexCoordsAsPartOfConnectedParticleSystem (ParticleSystem *ps)
 Method for initializing a particles texture coords as part of a connected particle system. More...
 

Protected Attributes

Shape _shape
 
rangef _sr
 
rangef _ar
 
rangev4 _cr
 
osg::ref_ptr< Interpolator_si
 
osg::ref_ptr< Interpolator_ai
 
osg::ref_ptr< Interpolator_ci
 
bool _mustdie
 
double _lifeTime
 
float _radius
 
float _mass
 
float _massinv
 
osg::Vec3 _prev_pos
 
osg::Vec3 _position
 
osg::Vec3 _velocity
 
osg::Vec3 _prev_angle
 
osg::Vec3 _angle
 
osg::Vec3 _angul_arvel
 
double _t0
 
float _alive
 
float _current_size
 
float _current_alpha
 
osg::Vec3 _base_prop
 
osg::Vec4 _current_color
 
float _s_tile
 
float _t_tile
 
int _start_tile
 
int _end_tile
 
int _cur_tile
 
float _s_coord
 
float _t_coord
 
int _previousParticle
 
int _nextParticle
 
double _depth
 
osg::ref_ptr< osg::Drawable_drawable
 

Friends

class ParticleSystem
 

Detailed Description

Implementation of a particle.

Objects of this class are particles, they have some graphical properties and some physical properties. Particles are created by emitters and then placed into Particle Systems, where they live and get updated at each frame. Particles can either live forever (lifeTime < 0), or die after a specified time (lifeTime >= 0). For each property which is defined as a range of values, a "current" value will be evaluated at each frame by interpolating the min and max values so that curr_value = min when t == 0, and curr_value = max when t == lifeTime. You may customize the interpolator objects to achieve any kind of transition. If you want the particle to live forever, set its lifetime to any value <= 0; in that case, no interpolation is done to compute real-time properties, and only minimum values are used.

Member Enumeration Documentation

anonymous enum
Enumerator
INVALID_INDEX 

Shape of particles.

NOTE: the LINE shape should be used in conjunction with FIXED alignment mode (see ParticleSystem).

Enumerator
POINT 
QUAD 
QUAD_TRIANGLESTRIP 
HEXAGON 
LINE 
USER 

Constructor & Destructor Documentation

osgParticle::Particle::Particle ( )

Member Function Documentation

void osgParticle::Particle::addAngularVelocity ( const osg::Vec3 dv)
inline

Add a vector to the angular velocity vector.

References _angul_arvel.

Referenced by osgParticle::AngularAccelOperator::operate().

void osgParticle::Particle::addVelocity ( const osg::Vec3 dv)
inline
void osgParticle::Particle::beginRender ( osg::GLBeginEndAdapter gl) const
inline

Perform some pre-rendering tasks. Called automatically by particle systems.

References _shape, osg::GLBeginEndAdapter::Begin(), LINE, POINT, and QUAD.

void osgParticle::Particle::endRender ( osg::GLBeginEndAdapter gl) const
inline

Perform some post-rendering tasks. Called automatically by particle systems.

References _shape, osg::GLBeginEndAdapter::End(), LINE, POINT, and QUAD.

double osgParticle::Particle::getAge ( ) const
inline

Get the age of the particle (in seconds).

References _t0.

const Interpolator * osgParticle::Particle::getAlphaInterpolator ( ) const
inline

Get the interpolator for computing alpha values.

References _ai.

const rangef & osgParticle::Particle::getAlphaRange ( ) const
inline

Get the minimum and maximum values for alpha.

References _ar.

const osg::Vec3 & osgParticle::Particle::getAngle ( ) const
inline

Get the angle vector.

References _angle.

const osg::Vec3 & osgParticle::Particle::getAngularVelocity ( ) const
inline

Get the rotational velocity vector.

References _angul_arvel.

Referenced by osgParticle::SinkOperator::getValue(), and osgParticle::AngularDampingOperator::operate().

const Interpolator * osgParticle::Particle::getColorInterpolator ( ) const
inline

Get the interpolator for computing color values.

References _ci.

const rangev4 & osgParticle::Particle::getColorRange ( ) const
inline

Get the minimum and maximum values for color.

References _cr.

float osgParticle::Particle::getCurrentAlpha ( ) const
inline

Get the current alpha.

const osg::Vec4& osgParticle::Particle::getCurrentColor ( ) const
inline

Get the current color.

float osgParticle::Particle::getCurrentSize ( ) const
inline

Get the current (interpolated) polygon size. Valid only after the first call to update().

References _current_size.

double osgParticle::Particle::getDepth ( ) const
inline

Get the depth of the particle.

osg::Drawable* osgParticle::Particle::getDrawable ( ) const
inline

Get the user-defined particle drawable.

double osgParticle::Particle::getLifeTime ( ) const
inline

Get the life time of the particle (in seconds).

References _lifeTime.

float osgParticle::Particle::getMass ( ) const
inline

Get the mass of the particle.

For built-in operators to work correctly, remember that the mass is expressed in kg.

References _mass.

float osgParticle::Particle::getMassInv ( ) const
inline

Get 1 / getMass().

References _massinv.

Referenced by osgParticle::ForceOperator::operate().

int osgParticle::Particle::getNextParticle ( ) const
inline

Get the const next particle.

int osgParticle::Particle::getNumTiles ( ) const
inline

Get number of texture tiles.

const osg::Vec3 & osgParticle::Particle::getPosition ( ) const
inline
const osg::Vec3 & osgParticle::Particle::getPreviousAngle ( ) const
inline

Get the previous angle vector.

References _prev_angle.

int osgParticle::Particle::getPreviousParticle ( ) const
inline

Get the previous particle.

const osg::Vec3 & osgParticle::Particle::getPreviousPosition ( ) const
inline

Get the previous position (the position before last update).

References _prev_pos.

float osgParticle::Particle::getRadius ( ) const
inline

Get the physical radius of the particle.

For built-in operators to work correctly, lengths must be expressed in meters.

References _radius.

Particle::Shape osgParticle::Particle::getShape ( ) const
inline

Get the shape of the particle.

References _shape.

const Interpolator * osgParticle::Particle::getSizeInterpolator ( ) const
inline

Get the interpolator for computing the size of polygons.

References _si.

const rangef & osgParticle::Particle::getSizeRange ( ) const
inline

Get the minimum and maximum values for polygon size.

References _sr.

float osgParticle::Particle::getSTexCoord ( ) const
inline

Get the s texture coordinate of the bottom left of the particle.

int osgParticle::Particle::getTileS ( ) const
inline

Get width of texture tile.

References _s_tile.

int osgParticle::Particle::getTileT ( ) const
inline

Get height of texture tile.

References _t_tile.

float osgParticle::Particle::getTTexCoord ( ) const
inline

Get the t texture coordinate of the bottom left of the particle.

const osg::Vec3 & osgParticle::Particle::getVelocity ( ) const
inline

Get the velocity vector.

For built-in operators to work correctly, remember that velocity components are expressed in meters per second.

References _velocity.

Referenced by osgParticle::SinkOperator::getValue(), and osgParticle::DampingOperator::operate().

bool osgParticle::Particle::isAlive ( ) const
inline

Get whether the particle is still alive.

References _alive.

Referenced by osgParticle::Operator::operateParticles().

void osgParticle::Particle::kill ( )
inline

Kill the particle on next update NOTE: after calling this function, the isAlive() method will still return true until the particle is updated again.

References _mustdie.

Referenced by osgParticle::SinkOperator::kill().

bool osgParticle::Particle::operator< ( const Particle P) const
inline

Sorting operator.

References _depth.

void osgParticle::Particle::render ( osg::GLBeginEndAdapter gl,
const osg::Vec3 xpos,
const osg::Vec3 px,
const osg::Vec3 py,
float  scale = 1.0f 
) const

Render the particle. Called automatically by particle systems.

void osgParticle::Particle::render ( osg::RenderInfo renderInfo,
const osg::Vec3 xpos,
const osg::Vec3 xrot 
) const

Render the particle with user-defined drawable.

void osgParticle::Particle::setAlphaInterpolator ( Interpolator ai)
inline

Set the interpolator for computing alpha values.

References _ai.

void osgParticle::Particle::setAlphaRange ( const rangef r)
inline

Set the minimum and maximum values for alpha.

References _ar.

void osgParticle::Particle::setAngle ( const osg::Vec3 a)
inline

Set the angle vector.

References _angle.

void osgParticle::Particle::setAngularVelocity ( const osg::Vec3 v)
inline

Set the angular velocity vector.

Components x, y and z are angles of rotation around the respective axis (in radians).

References _angul_arvel.

Referenced by osgParticle::AngularDampingOperator::operate(), and osgParticle::RadialShooter::shoot().

void osgParticle::Particle::setColorInterpolator ( Interpolator ci)
inline

Set the interpolator for computing color values.

References _ci.

void osgParticle::Particle::setColorRange ( const rangev4 r)
inline

Set the minimum and maximum values for color.

References _cr.

void osgParticle::Particle::setDepth ( double  d)
inline

Set the depth of the particle.

void osgParticle::Particle::setDrawable ( osg::Drawable d)
inline

Set the user-defined particle drawable.

void osgParticle::Particle::setLifeTime ( double  t)
inline

Set the life time of the particle.

References _lifeTime.

void osgParticle::Particle::setMass ( float  m)
inline

Set the mass of the particle.

For built-in operators to work correctly, remember that the mass is expressed in kg.

References _mass, and _massinv.

void osgParticle::Particle::setNextParticle ( int  next)
inline

Set the next particle.

void osgParticle::Particle::setPosition ( const osg::Vec3 p)
inline
void osgParticle::Particle::setPreviousParticle ( int  previous)
inline

Set the previous particle.

void osgParticle::Particle::setRadius ( float  r)
inline

Set the physical radius of the particle.

For built-in operators to work correctly, lengths must be expressed in meters.

References _radius.

void osgParticle::Particle::setShape ( Shape  s)
inline

Set the shape of the particle.

References _shape.

void osgParticle::Particle::setSizeInterpolator ( Interpolator ri)
inline

Set the interpolator for computing size values.

References _si.

void osgParticle::Particle::setSizeRange ( const rangef r)
inline

Set the minimum and maximum values for polygon size.

References _sr.

void osgParticle::Particle::setTextureTile ( int  sTile,
int  tTile,
int  end = -1 
)
inline

Same as above, range starts at 0 and ends at end.

References setTextureTileRange().

void osgParticle::Particle::setTextureTileRange ( int  sTile,
int  tTile,
int  startTile,
int  endTile 
)
inline

Specify how the particle texture is tiled.

All tiles in the given range are sequentially displayed during the lifetime of the particle. When no range is given, all tiles are displayed during the lifetime.

References _end_tile, _s_tile, _start_tile, and _t_tile.

Referenced by setTextureTile().

void osgParticle::Particle::setUpTexCoordsAsPartOfConnectedParticleSystem ( ParticleSystem ps)

Method for initializing a particles texture coords as part of a connected particle system.

void osgParticle::Particle::setVelocity ( const osg::Vec3 v)
inline

Set the velocity vector.

For built-in operators to work correctly, remember that velocity components are expressed in meters per second.

References _velocity.

Referenced by osgParticle::DampingOperator::operate(), and osgParticle::RadialShooter::shoot().

void osgParticle::Particle::transformAngleVelocity ( const osg::Matrix xform)
inline

Transform angle and angularVelocity vectors by a matrix.

References _angle, _angul_arvel, and osg::Matrixd::preMult().

void osgParticle::Particle::transformPositionVelocity ( const osg::Matrix xform)
inline

Transform position and velocity vectors by a matrix.

References _position, _velocity, osg::Matrixd::preMult(), and osg::Matrixd::transform3x3().

void osgParticle::Particle::transformPositionVelocity ( const osg::Matrix xform1,
const osg::Matrix xform2,
float  r 
)
inline

Transform position and velocity vectors by a combination of two matrices.

References _position, _velocity, osg::Matrixd::preMult(), and osg::Matrixd::transform3x3().

bool osgParticle::Particle::update ( double  dt,
bool  onlyTimeStamp 
)

Update the particle (don't call this method manually).

This method is called automatically by ParticleSystem::update(); it updates the graphical properties of the particle for the current time, checks whether the particle is still alive, and then updates its position by computing P = P + V * dt (where P is the position and V is the velocity).

Friends And Related Function Documentation

friend class ParticleSystem
friend

Member Data Documentation

osg::ref_ptr<Interpolator> osgParticle::Particle::_ai
protected
float osgParticle::Particle::_alive
protected

Referenced by isAlive().

osg::Vec3 osgParticle::Particle::_angle
protected
osg::Vec3 osgParticle::Particle::_angul_arvel
protected
rangef osgParticle::Particle::_ar
protected

Referenced by getAlphaRange(), and setAlphaRange().

osg::Vec3 osgParticle::Particle::_base_prop
protected
osg::ref_ptr<Interpolator> osgParticle::Particle::_ci
protected
rangev4 osgParticle::Particle::_cr
protected

Referenced by getColorRange(), and setColorRange().

int osgParticle::Particle::_cur_tile
protected
float osgParticle::Particle::_current_alpha
protected
osg::Vec4 osgParticle::Particle::_current_color
protected
float osgParticle::Particle::_current_size
protected

Referenced by getCurrentSize().

double osgParticle::Particle::_depth
protected

Referenced by operator<().

osg::ref_ptr<osg::Drawable> osgParticle::Particle::_drawable
protected
int osgParticle::Particle::_end_tile
protected

Referenced by setTextureTileRange().

double osgParticle::Particle::_lifeTime
protected

Referenced by getLifeTime(), and setLifeTime().

float osgParticle::Particle::_mass
protected

Referenced by getMass(), and setMass().

float osgParticle::Particle::_massinv
protected

Referenced by getMassInv(), and setMass().

bool osgParticle::Particle::_mustdie
protected

Referenced by kill().

int osgParticle::Particle::_nextParticle
protected
osg::Vec3 osgParticle::Particle::_position
protected
osg::Vec3 osgParticle::Particle::_prev_angle
protected

Referenced by getPreviousAngle().

osg::Vec3 osgParticle::Particle::_prev_pos
protected

Referenced by getPreviousPosition().

int osgParticle::Particle::_previousParticle
protected
float osgParticle::Particle::_radius
protected

Referenced by getRadius(), and setRadius().

float osgParticle::Particle::_s_coord
protected
float osgParticle::Particle::_s_tile
protected

Referenced by getTileS(), and setTextureTileRange().

Shape osgParticle::Particle::_shape
protected
osg::ref_ptr<Interpolator> osgParticle::Particle::_si
protected
rangef osgParticle::Particle::_sr
protected

Referenced by getSizeRange(), and setSizeRange().

int osgParticle::Particle::_start_tile
protected

Referenced by setTextureTileRange().

double osgParticle::Particle::_t0
protected

Referenced by getAge().

float osgParticle::Particle::_t_coord
protected
float osgParticle::Particle::_t_tile
protected

Referenced by getTileT(), and setTextureTileRange().

osg::Vec3 osgParticle::Particle::_velocity
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Wed Feb 13 2013 17:59:00 for the OpenSceneGraph by doxygen 1.8.3.1.