openscenegraph
Public Types | Public Member Functions | Protected Member Functions | List of all members
osgParticle::ParticleProcessor Class Reference
Inheritance diagram for osgParticle::ParticleProcessor:
osg::Node osg::Object osg::Referenced osgParticle::Emitter osgParticle::Program osgParticle::ModularEmitter osgParticle::FluidProgram osgParticle::ModularProgram

Public Types

enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
- Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions

 ParticleProcessor ()
 ParticleProcessor (const ParticleProcessor &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual const char * libraryName () const
virtual const char * className () const
virtual bool isSameKindAs (const osg::Object *obj) const
virtual void accept (osg::NodeVisitor &nv)
ReferenceFrame getReferenceFrame () const
 Get the reference frame.
void setReferenceFrame (ReferenceFrame rf)
 Set the reference frame.
bool getEnabled () const
 Get whether this processor is enabled or not.
bool isEnabled () const
void setEnabled (bool v)
 Set whether this processor is enabled or not.
ParticleSystemgetParticleSystem ()
 Get a pointer to the destination particle system.
const ParticleSystemgetParticleSystem () const
 Get a const pointer to the destination particle system.
void setParticleSystem (ParticleSystem *ps)
 Set the destination particle system.
void setEndless (bool type)
 Set the endless flag of this processor.
bool getEndless () const
 Check whether this processor is endless.
bool isEndless () const
void setLifeTime (double t)
 Set the lifetime of this processor.
double getLifeTime () const
 Get the lifetime of this processor.
void setStartTime (double t)
 Set the start time of this processor.
double getStartTime () const
 Get the start time of this processor.
void setCurrentTime (double t)
 Set the current time of this processor.
double getCurrentTime () const
 Get the current time of this processor.
void setResetTime (double t)
 Set the reset time of this processor. A value of 0 disables reset.
double getResetTime () const
 Get the reset time of this processor.
bool isAlive () const
void traverse (osg::NodeVisitor &nv)
const osg::MatrixgetLocalToWorldMatrix ()
 Get the current local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetWorldToLocalMatrix ()
 Get the current world-to-local transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousLocalToWorldMatrix ()
 Get the previous local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousWorldToLocalMatrix ()
 Get the previous world-to-local transformation matrix (valid only during cull traversal).
osg::Vec3 transformLocalToWorld (const osg::Vec3 &P)
 Transform a point from local to world coordinates (valid only during cull traversal).
osg::Vec3 rotateLocalToWorld (const osg::Vec3 &P)
 Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal).
osg::Vec3 transformWorldToLocal (const osg::Vec3 &P)
 Transform a point from world to local coordinates (valid only during cull traversal).
osg::Vec3 rotateWorldToLocal (const osg::Vec3 &P)
 Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal).
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 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 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 ~ParticleProcessor ()
ParticleProcessoroperator= (const ParticleProcessor &)
virtual void process (double dt)=0
- 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

- 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 common base interface for those classes which need to do something on particles. Such classes are, for example, Emitter (particle generation) and Program (particle animation). This class holds some properties, like a reference frame and a reference to a ParticleSystem; descendant classes should process the particles taking into account the reference frame, computing the right transformations when needed.

Member Enumeration Documentation

Enumerator:
RELATIVE_RF 
ABSOLUTE_RF 

Constructor & Destructor Documentation

osgParticle::ParticleProcessor::ParticleProcessor ( )
osgParticle::ParticleProcessor::ParticleProcessor ( const ParticleProcessor copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgParticle::ParticleProcessor::~ParticleProcessor ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osgParticle::ParticleProcessor::accept ( osg::NodeVisitor nv)
inlinevirtual

Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.

Reimplemented from osg::Node.

Reimplemented in osgParticle::Program, and osgParticle::Emitter.

References osg::NodeVisitor::apply(), osg::NodeVisitor::popFromNodePath(), osg::NodeVisitor::pushOntoNodePath(), and osg::NodeVisitor::validNodeMask().

virtual const char* osgParticle::ParticleProcessor::className ( ) const
inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

Reimplemented in osgParticle::Program, and osgParticle::Emitter.

virtual osg::BoundingSphere osgParticle::ParticleProcessor::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.

double osgParticle::ParticleProcessor::getCurrentTime ( ) const
inline

Get the current time of this processor.

bool osgParticle::ParticleProcessor::getEnabled ( ) const
inline

Get whether this processor is enabled or not.

bool osgParticle::ParticleProcessor::getEndless ( ) const
inline

Check whether this processor is endless.

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

Get the lifetime of this processor.

const osg::Matrix & osgParticle::ParticleProcessor::getLocalToWorldMatrix ( )
inline

Get the current local-to-world transformation matrix (valid only during cull traversal).

References osg::computeLocalToWorld(), and osg::NodeVisitor::getNodePath().

Referenced by getPreviousLocalToWorldMatrix(), rotateLocalToWorld(), and transformLocalToWorld().

ParticleSystem * osgParticle::ParticleProcessor::getParticleSystem ( )
inline

Get a pointer to the destination particle system.

References osg::ref_ptr< T >::get().

const ParticleSystem * osgParticle::ParticleProcessor::getParticleSystem ( ) const
inline

Get a const pointer to the destination particle system.

References osg::ref_ptr< T >::get().

const osg::Matrix & osgParticle::ParticleProcessor::getPreviousLocalToWorldMatrix ( )
inline

Get the previous local-to-world transformation matrix (valid only during cull traversal).

References getLocalToWorldMatrix().

const osg::Matrix & osgParticle::ParticleProcessor::getPreviousWorldToLocalMatrix ( )
inline

Get the previous world-to-local transformation matrix (valid only during cull traversal).

References getWorldToLocalMatrix().

ParticleProcessor::ReferenceFrame osgParticle::ParticleProcessor::getReferenceFrame ( ) const
inline
double osgParticle::ParticleProcessor::getResetTime ( ) const
inline

Get the reset time of this processor.

double osgParticle::ParticleProcessor::getStartTime ( ) const
inline

Get the start time of this processor.

const osg::Matrix & osgParticle::ParticleProcessor::getWorldToLocalMatrix ( )
inline

Get the current world-to-local transformation matrix (valid only during cull traversal).

References osg::computeWorldToLocal(), and osg::NodeVisitor::getNodePath().

Referenced by getPreviousWorldToLocalMatrix(), rotateWorldToLocal(), and transformWorldToLocal().

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

Check whether the processor is alive with respect to start time and life duration. Note that this method may return true even if the processor has been disabled by calling setEnabled(false). To test whether the processor is actually processing particles or not, you should evaluate (isEnabled() && isAlive()).

bool osgParticle::ParticleProcessor::isEnabled ( ) const
inline
bool osgParticle::ParticleProcessor::isEndless ( ) const
inline
virtual bool osgParticle::ParticleProcessor::isSameKindAs ( const osg::Object obj) const
inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

Reimplemented in osgParticle::Program, and osgParticle::Emitter.

virtual const char* osgParticle::ParticleProcessor::libraryName ( ) const
inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

Reimplemented in osgParticle::Program, and osgParticle::Emitter.

ParticleProcessor& osgParticle::ParticleProcessor::operator= ( const ParticleProcessor )
inlineprotected
virtual void osgParticle::ParticleProcessor::process ( double  dt)
protectedpure virtual
osg::Vec3 osgParticle::ParticleProcessor::rotateLocalToWorld ( const osg::Vec3 P)
inline

Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal).

References getLocalToWorldMatrix(), and osg::Matrixd::preMult().

Referenced by osgParticle::AngularAccelOperator::beginOperate(), osgParticle::ForceOperator::beginOperate(), and osgParticle::AccelOperator::beginOperate().

osg::Vec3 osgParticle::ParticleProcessor::rotateWorldToLocal ( const osg::Vec3 P)
inline

Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal).

References getWorldToLocalMatrix(), and osg::Matrixd::preMult().

void osgParticle::ParticleProcessor::setCurrentTime ( double  t)
inline

Set the current time of this processor.

void osgParticle::ParticleProcessor::setEnabled ( bool  v)
inline

Set whether this processor is enabled or not.

void osgParticle::ParticleProcessor::setEndless ( bool  type)
inline

Set the endless flag of this processor.

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

Set the lifetime of this processor.

void osgParticle::ParticleProcessor::setParticleSystem ( ParticleSystem ps)
inline

Set the destination particle system.

void osgParticle::ParticleProcessor::setReferenceFrame ( ReferenceFrame  rf)
inline

Set the reference frame.

void osgParticle::ParticleProcessor::setResetTime ( double  t)
inline

Set the reset time of this processor. A value of 0 disables reset.

void osgParticle::ParticleProcessor::setStartTime ( double  t)
inline

Set the start time of this processor.

osg::Vec3 osgParticle::ParticleProcessor::transformLocalToWorld ( const osg::Vec3 P)
inline

Transform a point from local to world coordinates (valid only during cull traversal).

References getLocalToWorldMatrix(), and osg::Matrixd::preMult().

Referenced by osgParticle::OrbitOperator::beginOperate(), and osgParticle::ExplosionOperator::beginOperate().

osg::Vec3 osgParticle::ParticleProcessor::transformWorldToLocal ( const osg::Vec3 P)
inline

Transform a point from world to local coordinates (valid only during cull traversal).

References getWorldToLocalMatrix(), and osg::Matrixd::preMult().

void osgParticle::ParticleProcessor::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: