OpenSceneGraph 3.6.5
|
An abstract ParticleProcessor
descendant for modifying particles "on the fly" during the cull traversal.
More...
#include <Program>
Public Member Functions | |
Program () | |
Program (const Program ©, const osg::CopyOp ©op=osg::CopyOp::SHALLOW_COPY) | |
virtual const char * | libraryName () const |
return the name of the node's library. | |
virtual const char * | className () const |
return the name of the node's class type. | |
virtual bool | isSameKindAs (const osg::Object *obj) const |
return true if this and obj are of the same kind of object. | |
virtual void | accept (osg::NodeVisitor &nv) |
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. | |
Public Member Functions inherited from osgParticle::ParticleProcessor | |
ParticleProcessor () | |
ParticleProcessor (const ParticleProcessor ©, const osg::CopyOp ©op=osg::CopyOp::SHALLOW_COPY) | |
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. | |
ParticleSystem * | getParticleSystem () |
Get a pointer to the destination particle system. | |
const ParticleSystem * | getParticleSystem () const |
Get a const pointer to the destination particle system. | |
virtual 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 |
Check whether the processor is alive with respect to start time and life duration. | |
void | traverse (osg::NodeVisitor &nv) |
Traverse downwards : calls children's accept method with NodeVisitor. | |
const osg::Matrix & | getLocalToWorldMatrix () |
Get the current local-to-world transformation matrix (valid only during cull traversal). | |
const osg::Matrix & | getWorldToLocalMatrix () |
Get the current world-to-local transformation matrix (valid only during cull traversal). | |
const osg::Matrix & | getPreviousLocalToWorldMatrix () |
Get the previous local-to-world transformation matrix (valid only during cull traversal). | |
const osg::Matrix & | getPreviousWorldToLocalMatrix () |
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 |
Compute the bounding sphere around Node's geometry or children. | |
Public Member Functions inherited from osg::Node | |
Node () | |
Construct a node. | |
Node (const Node &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor using CopyOp to manage deep vs shallow copy. | |
virtual Object * | cloneType () const |
clone an object of the same type as the node. | |
virtual Object * | clone (const CopyOp ©op) const |
return a clone of a node, with Object* return type. | |
virtual Node * | asNode () |
Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. | |
virtual const Node * | asNode () const |
convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. | |
virtual Drawable * | asDrawable () |
convert 'this' into a Drawable pointer if Node is a Drawable, otherwise return 0. | |
virtual const Drawable * | asDrawable () const |
convert 'const this' into a const Drawable pointer if Node is a Drawable, otherwise return 0. | |
virtual Geometry * | asGeometry () |
convert 'this' into a Geometry pointer if Node is a Geometry, otherwise return 0. | |
virtual const Geometry * | asGeometry () const |
convert 'const this' into a const Geometry pointer if Node is a Geometry, otherwise return 0. | |
virtual Group * | asGroup () |
convert 'this' into a Group pointer if Node is a Group, otherwise return 0. | |
virtual const Group * | asGroup () const |
convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. | |
virtual Transform * | asTransform () |
Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. | |
virtual const Transform * | asTransform () const |
convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. | |
virtual Switch * | asSwitch () |
Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. | |
virtual const Switch * | asSwitch () const |
convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. | |
virtual Geode * | asGeode () |
Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. | |
virtual const Geode * | asGeode () const |
convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. | |
virtual osgTerrain::Terrain * | asTerrain () |
Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. | |
virtual const osgTerrain::Terrain * | asTerrain () const |
convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. | |
virtual void | ascend (NodeVisitor &nv) |
Traverse upwards : calls parents' accept method with NodeVisitor. | |
const ParentList & | getParents () const |
Get the parent list of node. | |
ParentList | getParents () |
Get the a copy of parent list of node. | |
Group * | getParent (unsigned int i) |
const Group * | getParent (unsigned int i) const |
Get a single const parent of node. | |
unsigned int | getNumParents () const |
Get the number of parents of node. | |
NodePathList | getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const |
Get the list of node paths parent paths. | |
MatrixList | getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const |
Get the list of matrices that transform this node from local coordinates to world coordinates. | |
void | setUpdateCallback (Callback *nc) |
Set update node callback, called during update traversal. | |
template<class T> | |
void | setUpdateCallback (const ref_ptr< T > &nc) |
Callback * | getUpdateCallback () |
Get update node callback, called during update traversal. | |
const Callback * | getUpdateCallback () const |
Get const update node callback, called during update traversal. | |
void | addUpdateCallback (Callback *nc) |
Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. | |
template<class T> | |
void | addUpdateCallback (const ref_ptr< T > &nc) |
void | removeUpdateCallback (Callback *nc) |
Convenience method that removes a given callback from a node, even if that callback is nested. | |
template<class T> | |
void | removeUpdateCallback (const ref_ptr< T > &nc) |
unsigned int | getNumChildrenRequiringUpdateTraversal () const |
Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. | |
void | setEventCallback (Callback *nc) |
Set event node callback, called during event traversal. | |
template<class T> | |
void | setEventCallback (const ref_ptr< T > &nc) |
Callback * | getEventCallback () |
Get event node callback, called during event traversal. | |
const Callback * | getEventCallback () const |
Get const event node callback, called during event traversal. | |
void | addEventCallback (Callback *nc) |
Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. | |
template<class T> | |
void | addEventCallback (const ref_ptr< T > &nc) |
void | removeEventCallback (Callback *nc) |
Convenience method that removes a given callback from a node, even if that callback is nested. | |
template<class T> | |
void | removeEventCallback (const ref_ptr< T > &nc) |
unsigned int | getNumChildrenRequiringEventTraversal () const |
Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. | |
void | setCullCallback (Callback *nc) |
Set cull node callback, called during cull traversal. | |
template<class T> | |
void | setCullCallback (const ref_ptr< T > &nc) |
Callback * | getCullCallback () |
Get cull node callback, called during cull traversal. | |
const Callback * | getCullCallback () const |
Get const cull node callback, called during cull traversal. | |
void | addCullCallback (Callback *nc) |
Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. | |
template<class T> | |
void | addCullCallback (const ref_ptr< T > &nc) |
void | removeCullCallback (Callback *nc) |
Convenience method that removes a given callback from a node, even if that callback is nested. | |
template<class T> | |
void | removeCullCallback (const ref_ptr< T > &nc) |
void | setCullingActive (bool active) |
Set the view frustum/small feature culling of this node to be active or inactive. | |
bool | getCullingActive () const |
Get the view frustum/small feature _cullingActive flag for this node. | |
unsigned int | getNumChildrenWithCullingDisabled () const |
Get the number of Children of this node which have culling disabled. | |
bool | isCullingActive () const |
Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. | |
unsigned int | getNumChildrenWithOccluderNodes () const |
Get the number of Children of this node which are or have OccluderNode's. | |
bool | containsOccluderNodes () const |
return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. | |
void | setNodeMask (NodeMask nm) |
Set the node mask. | |
NodeMask | getNodeMask () const |
Get the node Mask. | |
void | setStateSet (osg::StateSet *stateset) |
Set the node's StateSet. | |
template<class T> | |
void | setStateSet (const osg::ref_ptr< T > &stateset) |
osg::StateSet * | getOrCreateStateSet () |
return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. | |
osg::StateSet * | getStateSet () |
Return the node's StateSet. | |
const osg::StateSet * | getStateSet () const |
Return the node's const StateSet. | |
void | setDescriptions (const DescriptionList &descriptions) |
Set the list of string descriptions. | |
DescriptionList & | getDescriptions () |
Get the description list of the node. | |
const DescriptionList & | getDescriptions () const |
Get the const description list of the const node. | |
const std::string & | getDescription (unsigned int i) const |
Get a single const description of the const node. | |
std::string & | getDescription (unsigned int i) |
Get a single description of the node. | |
unsigned int | getNumDescriptions () const |
Get the number of descriptions of the node. | |
void | addDescription (const std::string &desc) |
Add a description string to the node. | |
void | setInitialBound (const osg::BoundingSphere &bsphere) |
Set the initial bounding volume to use when computing the overall bounding volume. | |
const BoundingSphere & | getInitialBound () const |
Set the initial bounding volume to use when computing the overall bounding volume. | |
void | dirtyBound () |
Mark this node's bounding sphere dirty. | |
const BoundingSphere & | getBound () const |
void | setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback) |
Set the compute bound callback to override the default computeBound. | |
template<class T> | |
void | setComputeBoundingSphereCallback (const ref_ptr< T > &callback) |
ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () |
Get the compute bound callback. | |
const ComputeBoundingSphereCallback * | getComputeBoundingSphereCallback () const |
Get the const compute bound callback. | |
virtual void | setThreadSafeRefUnref (bool threadSafe) |
Set whether to use a mutex to ensure ref() and unref() are thread safe. | |
virtual void | resizeGLObjectBuffers (unsigned int) |
Resize any per context GLObject buffers to specified size. | |
virtual void | releaseGLObjects (osg::State *=0) const |
If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. | |
Public Member Functions inherited from osg::Object | |
Object () | |
Construct an object. | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. | |
std::string | getCompoundClassName () const |
return the compound class name that combines the library name and class name. | |
virtual NodeVisitor * | asNodeVisitor () |
Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. | |
virtual const NodeVisitor * | asNodeVisitor () const |
convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. | |
virtual StateSet * | asStateSet () |
Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. | |
virtual const StateSet * | asStateSet () const |
convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. | |
virtual StateAttribute * | asStateAttribute () |
Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. | |
virtual const StateAttribute * | asStateAttribute () const |
convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. | |
virtual Uniform * | asUniform () |
Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. | |
virtual const Uniform * | asUniform () const |
convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. | |
virtual Camera * | asCamera () |
Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. | |
virtual const Camera * | asCamera () const |
convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. | |
virtual Callback * | asCallback () |
Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. | |
virtual const Callback * | asCallback () const |
convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. | |
virtual CallbackObject * | asCallbackObject () |
Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. | |
virtual const CallbackObject * | asCallbackObject () const |
convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. | |
virtual UserDataContainer * | asUserDataContainer () |
Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. | |
virtual const UserDataContainer * | asUserDataContainer () const |
convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. | |
virtual ValueObject * | asValueObject () |
Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. | |
virtual const ValueObject * | asValueObject () const |
Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. | |
virtual Image * | asImage () |
Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. | |
virtual const Image * | asImage () const |
Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. | |
virtual void | setName (const std::string &name) |
Set the name of object using C++ style string. | |
void | setName (const char *name) |
Set the name of object using a C style string. | |
const std::string & | getName () const |
Get the name of object. | |
void | setDataVariance (DataVariance dv) |
Set the data variance of this object. | |
DataVariance | getDataVariance () const |
Get the data variance of this object. | |
virtual void | computeDataVariance () |
Compute the DataVariance based on an assessment of callback etc. | |
void | setUserDataContainer (osg::UserDataContainer *udc) |
set the UserDataContainer object. | |
template<class T> | |
void | setUserDataContainer (const ref_ptr< T > &udc) |
osg::UserDataContainer * | getUserDataContainer () |
get the UserDataContainer attached to this object. | |
const osg::UserDataContainer * | getUserDataContainer () const |
get the const UserDataContainer attached to this object. | |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. | |
virtual void | setUserData (Referenced *obj) |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. | |
template<class T> | |
void | setUserData (const ref_ptr< T > &ud) |
virtual Referenced * | getUserData () |
Get user data. | |
virtual const Referenced * | getUserData () const |
Get const user data. | |
template<typename T> | |
bool | getUserValue (const std::string &name, T &value) const |
Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. | |
template<typename T> | |
void | setUserValue (const std::string &name, const T &value) |
Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. | |
template<typename T> | |
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool | getUserValue (const std::string &name, T &value) const |
provide implementation of osg::Object::getUserValue(..) template | |
Public Member Functions inherited from osg::Referenced | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. | |
Referenced (const Referenced &) | |
Referenced & | operator= (const Referenced &) |
bool | getThreadSafeRefUnref () const |
Get whether a mutex is used to ensure ref() and unref() are thread safe. | |
OpenThreads::Mutex * | getRefMutex () const |
Get the mutex used to ensure thread safety of ref()/unref(). | |
int | ref () const |
Increment the reference count by one, indicating that this object has another pointer which is referencing it. | |
int | unref () const |
Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. | |
int | unref_nodelete () const |
Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. | |
int | referenceCount () const |
Return the number of pointers currently referencing this object. | |
ObserverSet * | getObserverSet () const |
Get the ObserverSet if one is attached, otherwise return NULL. | |
ObserverSet * | getOrCreateObserverSet () const |
Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. | |
void | addObserver (Observer *observer) const |
Add a Observer that is observing this object, notify the Observer when this object gets deleted. | |
void | removeObserver (Observer *observer) const |
Remove Observer that is observing this object. |
Protected Member Functions | |
virtual | ~Program () |
Program & | operator= (const Program &) |
void | process (double dt) |
Implementation of ParticleProcessor::process() . Do not call this method by yourself. | |
virtual void | execute (double dt)=0 |
Execute the program on the particle system. Must be overridden in descendant classes. | |
Protected Member Functions inherited from osgParticle::ParticleProcessor | |
virtual | ~ParticleProcessor () |
ParticleProcessor & | operator= (const ParticleProcessor &) |
Protected Member Functions inherited from osg::Node | |
virtual | ~Node () |
Node destructor. | |
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 () |
Object destructor. | |
Protected Member Functions inherited from osg::Referenced | |
virtual | ~Referenced () |
void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
void | deleteUsingDeleteHandler () const |
An abstract ParticleProcessor
descendant for modifying particles "on the fly" during the cull traversal.
Descendants of this class must implement the execute()
method, which should iterate through all particles in the linked particle system and modify them somehow (usually updating their velocity vector).
osgParticle::Program::Program | ( | ) |
Referenced by isSameKindAs(), operator=(), and Program().
osgParticle::Program::Program | ( | const Program & | copy, |
const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY ) |
References Program(), and osg::CopyOp::SHALLOW_COPY.
|
inlineprotectedvirtual |
|
inlinevirtual |
Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
Reimplemented from osgParticle::ParticleProcessor.
References osg::NodeVisitor::apply(), osg::NodeVisitor::popFromNodePath(), osg::NodeVisitor::pushOntoNodePath(), and osg::NodeVisitor::validNodeMask().
|
inlinevirtual |
return the name of the node's class type.
Reimplemented from osgParticle::ParticleProcessor.
|
protectedpure virtual |
Execute the program on the particle system. Must be overridden in descendant classes.
Implemented in osgParticle::FluidProgram, and osgParticle::ModularProgram.
Referenced by process().
|
inlinevirtual |
return true if this and obj are of the same kind of object.
Reimplemented from osgParticle::ParticleProcessor.
References Program().
|
inlinevirtual |
return the name of the node's library.
Reimplemented from osgParticle::ParticleProcessor.
|
inlineprotectedvirtual |
Implementation of ParticleProcessor::process()
. Do not call this method by yourself.
Implements osgParticle::ParticleProcessor.
References execute().
![]() | Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0. |