OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
osgParticle::ParticleProcessor Class Referenceabstract

#include <ParticleProcessor.h>

Inheritance diagram for osgParticle::ParticleProcessor:
Inheritance graph
[legend]
Collaboration diagram for osgParticle::ParticleProcessor:
Collaboration graph
[legend]

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. More...
 
void setReferenceFrame (ReferenceFrame rf)
 Set the reference frame. More...
 
bool getEnabled () const
 Get whether this processor is enabled or not. More...
 
bool isEnabled () const
 
void setEnabled (bool v)
 Set whether this processor is enabled or not. More...
 
ParticleSystem * getParticleSystem ()
 Get a pointer to the destination particle system. More...
 
const ParticleSystem * getParticleSystem () const
 Get a const pointer to the destination particle system. More...
 
void setParticleSystem (ParticleSystem *ps)
 Set the destination particle system. More...
 
void setEndless (bool type)
 Set the endless flag of this processor. More...
 
bool getEndless () const
 Check whether this processor is endless. More...
 
bool isEndless () const
 
void setLifeTime (double t)
 Set the lifetime of this processor. More...
 
double getLifeTime () const
 Get the lifetime of this processor. More...
 
void setStartTime (double t)
 Set the start time of this processor. More...
 
double getStartTime () const
 Get the start time of this processor. More...
 
void setCurrentTime (double t)
 Set the current time of this processor. More...
 
double getCurrentTime () const
 Get the current time of this processor. More...
 
void setResetTime (double t)
 Set the reset time of this processor. A value of 0 disables reset. More...
 
double getResetTime () const
 Get the reset time of this processor. More...
 
bool isAlive () const
 
void traverse (osg::NodeVisitor &nv)
 
const osg::Matrix & getLocalToWorldMatrix ()
 Get the current local-to-world transformation matrix (valid only during cull traversal). More...
 
const osg::Matrix & getWorldToLocalMatrix ()
 Get the current world-to-local transformation matrix (valid only during cull traversal). More...
 
const osg::Matrix & getPreviousLocalToWorldMatrix ()
 Get the previous local-to-world transformation matrix (valid only during cull traversal). More...
 
const osg::Matrix & getPreviousWorldToLocalMatrix ()
 Get the previous world-to-local transformation matrix (valid only during cull traversal). More...
 
osg::Vec3 transformLocalToWorld (const osg::Vec3 &P)
 Transform a point from local to world coordinates (valid only during cull traversal). More...
 
osg::Vec3 rotateLocalToWorld (const osg::Vec3 &P)
 Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal). More...
 
osg::Vec3 transformWorldToLocal (const osg::Vec3 &P)
 Transform a point from world to local coordinates (valid only during cull traversal). More...
 
osg::Vec3 rotateWorldToLocal (const osg::Vec3 &P)
 Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal). More...
 
virtual osg::BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual Object * cloneType () const
 
virtual Object * clone (const CopyOp &copyop) const
 
virtual Node * asNode ()
 
virtual const Node * asNode () const
 
virtual Drawable * asDrawable ()
 
virtual const Drawable * asDrawable () const
 
virtual Geometry * asGeometry ()
 
virtual const Geometry * asGeometry () const
 
virtual Group * asGroup ()
 
virtual const Group * asGroup () const
 
virtual Transform * asTransform ()
 
virtual const Transform * asTransform () const
 
virtual Camera * asCamera ()
 
virtual const Camera * asCamera () const
 
virtual Switch * asSwitch ()
 
virtual const Switch * asSwitch () const
 
virtual Geode * asGeode ()
 
virtual const Geode * asGeode () const
 
virtual osgTerrain::Terrain * asTerrain ()
 
virtual const osgTerrain::Terrain * asTerrain () const
 
virtual void ascend (NodeVisitor &nv)
 
const ParentList & getParents () const
 
ParentList getParents ()
 
Group * getParent (unsigned int i)
 
const Group * getParent (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 (Callback *nc)
 
Callback * getUpdateCallback ()
 
const Callback * getUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
void removeUpdateCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
Callback * getEventCallback ()
 
const Callback * getEventCallback () const
 
void addEventCallback (Callback *nc)
 
void removeEventCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
Callback * getCullCallback ()
 
const Callback * getCullCallback () const
 
void addCullCallback (Callback *nc)
 
void removeCullCallback (Callback *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::StateSet * getOrCreateStateSet ()
 
osg::StateSet * getStateSet ()
 
const osg::StateSet * getStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionList & getDescriptions ()
 
const DescriptionList & getDescriptions () 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 BoundingSphere & getInitialBound () const
 
void dirtyBound ()
 
const BoundingSphere & getBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
ComputeBoundingSphereCallback * getComputeBoundingSphereCallback ()
 
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)
 
std::string getCompoundClassName () const
 
virtual NodeVisitor * asNodeVisitor ()
 
virtual const NodeVisitor * asNodeVisitor () const
 
virtual StateAttribute * asStateAttribute ()
 
virtual const StateAttribute * asStateAttribute () const
 
virtual Uniform * asUniform ()
 
virtual const Uniform * asUniform () const
 
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::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () 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)
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject
BoundingBoxdValueObject
BoundingSpheredValueObject
bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~ParticleProcessor ()
 
ParticleProcessor & operator= (const ParticleProcessor &)
 
virtual void process (double dt)=0
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *parent)
 
void removeParent (osg::Group *parent)
 
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::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr
< ComputeBoundingSphereCallback > 		_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< Callback > _updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< Callback > _eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< Callback > _cullCallback
 
bool _cullingActive
 
unsigned int _numChildrenWithCullingDisabled
 
unsigned int _numChildrenWithOccluderNodes
 
NodeMask _nodeMask
 
ref_ptr< StateSet > _stateset
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer * _userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

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.

Definition at line 38 of file ParticleProcessor.h.

Member Enumeration Documentation

enum osgParticle::ParticleProcessor::ReferenceFrame
Enumerator
RELATIVE_RF 
ABSOLUTE_RF 

Definition at line 41 of file ParticleProcessor.h.

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

Definition at line 146 of file ParticleProcessor.h.

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.

Definition at line 52 of file ParticleProcessor.h.

Here is the call graph for this function:

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.

Definition at line 50 of file ParticleProcessor.h.

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.

Definition at line 253 of file ParticleProcessor.h.

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

Get whether this processor is enabled or not.

Definition at line 61 of file ParticleProcessor.h.

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

Check whether this processor is endless.

Definition at line 80 of file ParticleProcessor.h.

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

Get the lifetime of this processor.

Definition at line 234 of file ParticleProcessor.h.

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

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

Definition at line 268 of file ParticleProcessor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Get a pointer to the destination particle system.

Definition at line 204 of file ParticleProcessor.h.

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

Get a const pointer to the destination particle system.

Definition at line 209 of file ParticleProcessor.h.

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

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

Definition at line 298 of file ParticleProcessor.h.

Here is the call graph for this function:

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

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

Definition at line 304 of file ParticleProcessor.h.

Here is the call graph for this function:

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

Get the reference frame.

Definition at line 180 of file ParticleProcessor.h.

Here is the caller graph for this function:

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

Get the reset time of this processor.

Definition at line 263 of file ParticleProcessor.h.

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

Get the start time of this processor.

Definition at line 244 of file ParticleProcessor.h.

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

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

Definition at line 283 of file ParticleProcessor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 332 of file ParticleProcessor.h.

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

Definition at line 190 of file ParticleProcessor.h.

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

Definition at line 224 of file ParticleProcessor.h.

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.

Definition at line 51 of file ParticleProcessor.h.

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.

Definition at line 49 of file ParticleProcessor.h.

ParticleProcessor& osgParticle::ParticleProcessor::operator= ( const ParticleProcessor &  )
inlineprotected

Definition at line 147 of file ParticleProcessor.h.

virtual void osgParticle::ParticleProcessor::process ( double  dt)
protectedpure virtual

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

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).

Definition at line 320 of file ParticleProcessor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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).

Definition at line 326 of file ParticleProcessor.h.

Here is the call graph for this function:

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

Set the current time of this processor.

Definition at line 248 of file ParticleProcessor.h.

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

Set whether this processor is enabled or not.

Definition at line 195 of file ParticleProcessor.h.

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

Set the endless flag of this processor.

Definition at line 219 of file ParticleProcessor.h.

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

Set the lifetime of this processor.

Definition at line 229 of file ParticleProcessor.h.

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

Set the destination particle system.

Definition at line 214 of file ParticleProcessor.h.

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

Set the reference frame.

Definition at line 185 of file ParticleProcessor.h.

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

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

Definition at line 258 of file ParticleProcessor.h.

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

Set the start time of this processor.

Definition at line 239 of file ParticleProcessor.h.

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

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

Definition at line 310 of file ParticleProcessor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Definition at line 315 of file ParticleProcessor.h.

Here is the call graph for this function:

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:
Generated on Tue Oct 4 2016 19:20:54 for OSG by   doxygen 1.8.8