OpenSceneGraph 2.8.3

osgParticle::ParticleSystemUpdater Class Reference

A useful node class for updating particle systems automatically. More...

Inheritance diagram for osgParticle::ParticleSystemUpdater:

List of all members.

Public Member Functions

 ParticleSystemUpdater ()
 ParticleSystemUpdater (const ParticleSystemUpdater &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osgParticle, ParticleSystemUpdater)
virtual bool addParticleSystem (ParticleSystem *ps)
 Add a particle system to the list.
virtual bool removeParticleSystem (ParticleSystem *ps)
 Remove a particle system from the list (by pointer).
virtual bool removeParticleSystem (unsigned int i, unsigned int numParticleSystemsToRemove=1)
 Remove a particle system(s) from the list (by index).
virtual bool replaceParticleSystem (ParticleSystem *origPS, ParticleSystem *newPS)
 Replace ParticleSystem with another ParticleSystem.
virtual bool setParticleSystem (unsigned int i, ParticleSystem *ps)
 set a particle system by index.
unsigned int getNumParticleSystems () const
 Return the number of particle systems on the list.
ParticleSystemgetParticleSystem (unsigned int i)
 Get a particle system from the list.
const ParticleSystemgetParticleSystem (unsigned int i) const
 Get a particle system from the list.
bool containsParticleSystem (const ParticleSystem *ps) const
 return true if ParticleSystem is contained within ParticlsSystemUpdater.
unsigned int getParticleSystemIndex (const ParticleSystem *ps) const
 get index number of ParticleSystem.
virtual void traverse (osg::NodeVisitor &nv)
 Traverse downwards : calls children's accept method with NodeVisitor.
virtual osg::BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.

Protected Member Functions

virtual ~ParticleSystemUpdater ()
ParticleSystemUpdateroperator= (const ParticleSystemUpdater &)

Detailed Description

A useful node class for updating particle systems automatically.

When a ParticleSystemUpdater is traversed by a cull visitor, it calls the update() method on the specified particle systems. You should place this updater AFTER other nodes like emitters and programs.


Constructor & Destructor Documentation

osgParticle::ParticleSystemUpdater::ParticleSystemUpdater ( )
osgParticle::ParticleSystemUpdater::ParticleSystemUpdater ( const ParticleSystemUpdater copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgParticle::ParticleSystemUpdater::~ParticleSystemUpdater ( ) [inline, protected, virtual]

Member Function Documentation

virtual bool osgParticle::ParticleSystemUpdater::addParticleSystem ( ParticleSystem ps) [virtual]

Add a particle system to the list.

virtual osg::BoundingSphere osgParticle::ParticleSystemUpdater::computeBound ( ) const [virtual]

Compute the bounding sphere around Node's geometry or children.

This method is automatically called by getBound() when the bounding sphere has been marked dirty via dirtyBound().

Reimplemented from osg::Node.

bool osgParticle::ParticleSystemUpdater::containsParticleSystem ( const ParticleSystem ps) const [inline]

return true if ParticleSystem is contained within ParticlsSystemUpdater.

unsigned int osgParticle::ParticleSystemUpdater::getNumParticleSystems ( ) const [inline]

Return the number of particle systems on the list.

const ParticleSystem * osgParticle::ParticleSystemUpdater::getParticleSystem ( unsigned int  i) const [inline]

Get a particle system from the list.

ParticleSystem * osgParticle::ParticleSystemUpdater::getParticleSystem ( unsigned int  i) [inline]

Get a particle system from the list.

unsigned int osgParticle::ParticleSystemUpdater::getParticleSystemIndex ( const ParticleSystem ps) const [inline]

get index number of ParticleSystem.

osgParticle::ParticleSystemUpdater::META_Node ( osgParticle  ,
ParticleSystemUpdater   
)
ParticleSystemUpdater& osgParticle::ParticleSystemUpdater::operator= ( const ParticleSystemUpdater ) [inline, protected]
virtual bool osgParticle::ParticleSystemUpdater::removeParticleSystem ( unsigned int  i,
unsigned int  numParticleSystemsToRemove = 1 
) [virtual]

Remove a particle system(s) from the list (by index).

virtual bool osgParticle::ParticleSystemUpdater::removeParticleSystem ( ParticleSystem ps) [virtual]

Remove a particle system from the list (by pointer).

virtual bool osgParticle::ParticleSystemUpdater::replaceParticleSystem ( ParticleSystem origPS,
ParticleSystem newPS 
) [virtual]

Replace ParticleSystem with another ParticleSystem.

virtual bool osgParticle::ParticleSystemUpdater::setParticleSystem ( unsigned int  i,
ParticleSystem ps 
) [virtual]

set a particle system by index.

virtual void osgParticle::ParticleSystemUpdater::traverse ( osg::NodeVisitor ) [virtual]

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Node.


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

osg logo
Generated at Tue Mar 22 2011 13:20:28 for the OpenSceneGraph by doxygen 1.7.3.