openscenegraph
Public Member Functions | Protected Member Functions | List of all members
osgParticle::ParticleSystemUpdater Class Reference
Inheritance diagram for osgParticle::ParticleSystemUpdater:
osg::Node osg::Object osg::Referenced

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)
virtual osg::BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Member Functions

virtual ~ParticleSystemUpdater ()
ParticleSystemUpdateroperator= (const ParticleSystemUpdater &)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Additional Inherited Members

- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr
< ComputeBoundingSphereCallback
_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< NodeCallback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< NodeCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< NodeCallback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset

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 ( )
inlineprotectedvirtual

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.

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

Get a particle system from the list.

const ParticleSystem * osgParticle::ParticleSystemUpdater::getParticleSystem ( unsigned int  i) const
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 )
inlineprotected
virtual bool osgParticle::ParticleSystemUpdater::removeParticleSystem ( ParticleSystem ps)
virtual

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

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::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: