OpenSceneGraph
3.0.1
|
Visitor for type safe operations on osg::Nodes. More...
Classes | |
class | DatabaseRequestHandler |
Callback for managing database paging, such as generated by PagedLOD nodes. More... | |
class | ImageRequestHandler |
Callback for managing image paging, such as generated by PagedLOD nodes. More... |
Public Types | |
enum | TraversalMode { TRAVERSE_NONE, TRAVERSE_PARENTS, TRAVERSE_ALL_CHILDREN, TRAVERSE_ACTIVE_CHILDREN } |
enum | VisitorType { NODE_VISITOR = 0, UPDATE_VISITOR, EVENT_VISITOR, COLLECT_OCCLUDER_VISITOR, CULL_VISITOR } |
Public Member Functions | |
NodeVisitor (TraversalMode tm=TRAVERSE_NONE) | |
NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE) | |
virtual | ~NodeVisitor () |
virtual const char * | libraryName () const |
return the library name/namespapce of the visitor's. | |
virtual const char * | className () const |
return the name of the visitor's class type. | |
virtual void | reset () |
Method to call to reset visitor. | |
void | setVisitorType (VisitorType type) |
Set the VisitorType, used to distinguish different visitors during traversal of the scene, typically used in the Node::traverse() method to select which behaviour to use for different types of traversal/visitors. | |
VisitorType | getVisitorType () const |
Get the VisitorType. | |
void | setTraversalNumber (unsigned int fn) |
Set the traversal number. | |
unsigned int | getTraversalNumber () const |
Get the traversal number. | |
void | setFrameStamp (FrameStamp *fs) |
Set the FrameStamp that this traversal is associated with. | |
const FrameStamp * | getFrameStamp () const |
Get the FrameStamp that this traversal is associated with. | |
void | setTraversalMask (Node::NodeMask mask) |
Set the TraversalMask of this NodeVisitor. | |
Node::NodeMask | getTraversalMask () const |
Get the TraversalMask. | |
void | setNodeMaskOverride (Node::NodeMask mask) |
Set the NodeMaskOverride mask. | |
Node::NodeMask | getNodeMaskOverride () const |
Get the NodeMaskOverride mask. | |
bool | validNodeMask (const osg::Node &node) const |
Method to called by Node and its subclass' Node::accept() method, if the result is true it is used to cull operations of nodes and their subgraphs. | |
void | setTraversalMode (TraversalMode mode) |
Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse. | |
TraversalMode | getTraversalMode () const |
Get the traversal mode. | |
void | setUserData (Referenced *obj) |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. | |
Referenced * | getUserData () |
Get user data. | |
const Referenced * | getUserData () const |
Get const user data. | |
void | traverse (Node &node) |
Method for handling traversal of a nodes. | |
void | pushOntoNodePath (Node *node) |
Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..). | |
void | popFromNodePath () |
Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..). | |
NodePath & | getNodePath () |
Get the non const NodePath from the top most node applied down to the current Node being visited. | |
const NodePath & | getNodePath () const |
Get the const NodePath from the top most node applied down to the current Node being visited. | |
virtual osg::Vec3 | getEyePoint () const |
Get the eye point in local coordinates. | |
virtual osg::Vec3 | getViewPoint () const |
Get the view point in local coordinates. | |
virtual float | getDistanceToEyePoint (const Vec3 &, bool) const |
Get the distance from a point to the eye point, distance value in local coordinate system. | |
virtual float | getDistanceFromEyePoint (const Vec3 &, bool) const |
Get the distance of a point from the eye point, distance value in the eye coordinate system. | |
virtual float | getDistanceToViewPoint (const Vec3 &, bool) const |
Get the distance from a point to the view point, distance value in local coordinate system. | |
virtual void | apply (Node &node) |
virtual void | apply (Geode &node) |
virtual void | apply (Billboard &node) |
virtual void | apply (Group &node) |
virtual void | apply (ProxyNode &node) |
virtual void | apply (Projection &node) |
virtual void | apply (CoordinateSystemNode &node) |
virtual void | apply (ClipNode &node) |
virtual void | apply (TexGenNode &node) |
virtual void | apply (LightSource &node) |
virtual void | apply (Transform &node) |
virtual void | apply (Camera &node) |
virtual void | apply (CameraView &node) |
virtual void | apply (MatrixTransform &node) |
virtual void | apply (PositionAttitudeTransform &node) |
virtual void | apply (Switch &node) |
virtual void | apply (Sequence &node) |
virtual void | apply (LOD &node) |
virtual void | apply (PagedLOD &node) |
virtual void | apply (ClearNode &node) |
virtual void | apply (OccluderNode &node) |
virtual void | apply (OcclusionQueryNode &node) |
void | setDatabaseRequestHandler (DatabaseRequestHandler *handler) |
Set the handler for database requests. | |
DatabaseRequestHandler * | getDatabaseRequestHandler () |
Get the handler for database requests. | |
const DatabaseRequestHandler * | getDatabaseRequestHandler () const |
Get the const handler for database requests. | |
void | setImageRequestHandler (ImageRequestHandler *handler) |
Set the handler for image requests. | |
ImageRequestHandler * | getImageRequestHandler () |
Get the handler for image requests. | |
const ImageRequestHandler * | getImageRequestHandler () const |
Get the const handler for image requests. | |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (const Referenced &) |
virtual void | setThreadSafeRefUnref (bool threadSafe) |
Set whether to use a mutex to ensure ref() and unref() are thread safe. | |
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 referencing it. | |
int | unref_nodelete () const |
Decrement the reference count by one, indicating that a pointer to this object is 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 Attributes | |
VisitorType | _visitorType |
unsigned int | _traversalNumber |
ref_ptr< FrameStamp > | _frameStamp |
TraversalMode | _traversalMode |
Node::NodeMask | _traversalMask |
Node::NodeMask | _nodeMaskOverride |
NodePath | _nodePath |
ref_ptr< Referenced > | _userData |
ref_ptr< DatabaseRequestHandler > | _databaseRequestHandler |
ref_ptr< ImageRequestHandler > | _imageRequestHandler |
![]() | |
OpenThreads::AtomicPtr | _observerSet |
OpenThreads::Atomic | _refCount |
Additional Inherited Members | |
![]() | |
static OpenThreads::Mutex * | getGlobalReferencedMutex () |
Get the optional global Referenced mutex, this can be shared between all osg::Referenced. | |
static void | setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting) |
Set whether reference counting should use a mutex for thread safe reference counting. | |
static bool | getThreadSafeReferenceCounting () |
Get whether reference counting is active. | |
static void | setDeleteHandler (DeleteHandler *handler) |
Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. | |
static DeleteHandler * | getDeleteHandler () |
Get a DeleteHandler. | |
![]() | |
virtual | ~Referenced () |
void | signalObserversAndDelete (bool signalDelete, bool doDelete) const |
void | deleteUsingDeleteHandler () const |
Visitor for type safe operations on osg::Nodes.
Based on GOF's Visitor pattern. The NodeVisitor is useful for developing type safe operations to nodes in the scene graph (as per Visitor pattern), and adds to this support for optional scene graph traversal to allow operations to be applied to whole scenes at once. The Visitor pattern uses a technique of double dispatch as a mechanism to call the appropriate apply(..) method of the NodeVisitor. To use this feature one must use the Node::accept(NodeVisitor) which is extended in each Node subclass, rather than the NodeVisitor apply directly. So use root->accept(myVisitor); instead of myVisitor.apply(*root). The later method will bypass the double dispatch and the appropriate NodeVisitor::apply(..) method will not be called.
osg::NodeVisitor::NodeVisitor | ( | TraversalMode | tm = TRAVERSE_NONE | ) |
osg::NodeVisitor::NodeVisitor | ( | VisitorType | type, |
TraversalMode | tm = TRAVERSE_NONE |
||
) |
|
virtual |
Reimplemented in osgUtil::Optimizer::StaticObjectDetectionVisitor, osgUtil::Optimizer::TextureAtlasVisitor, osgUtil::Optimizer::TextureVisitor, osgUtil::Optimizer::CopySharedSubgraphsVisitor, osgUtil::Optimizer::StateVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::GLObjectsVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::ShaderGenVisitor, osgDB::SharedStateManager, osgUtil::DisplayRequirementsVisitor, osgUtil::UpdateVisitor, osgUtil::StateToCompile, osg::CollectOccludersVisitor, osgSim::InsertImpostorsVisitor, osg::ComputeBoundsVisitor, osgAnimation::LinkVisitor, osgAnimation::BoneMapVisitor, and osgUtil::PrintVisitor.
Referenced by osgParticle::PrecipitationEffect::accept(), osgParticle::Emitter::accept(), osgParticle::ParticleEffect::accept(), osgParticle::Program::accept(), and osgParticle::ParticleProcessor::accept().
Reimplemented in osgUtil::Optimizer::StaticObjectDetectionVisitor, osgUtil::Optimizer::TextureAtlasVisitor, osgUtil::Optimizer::TextureVisitor, osgUtil::Optimizer::SpatializeGroupsVisitor, osgUtil::Optimizer::MergeGeometryVisitor, osgUtil::Optimizer::MakeFastGeometryVisitor, osgUtil::Optimizer::CheckGeometryVisitor, osgUtil::Optimizer::StateVisitor, osgUtil::Optimizer::TessellateVisitor, osgUtil::Optimizer::RemoveEmptyNodesVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osg::KdTreeBuilder, osgUtil::IntersectVisitor, osgUtil::GLObjectsVisitor, osgUtil::CullVisitor, osgUtil::Simplifier, osgUtil::VertexCacheMissVisitor, osgGA::EventVisitor, osgUtil::ShaderGenVisitor, osgDB::SharedStateManager, osgUtil::TriStripVisitor, osgUtil::DisplayRequirementsVisitor, osgUtil::UpdateVisitor, osgUtil::StateToCompile, osg::ComputeBoundsVisitor, osgUtil::SmoothingVisitor, osgUtil::DrawElementTypeSimplifierVisitor, osgUtil::GeometryCollector, and osgAnimation::LinkVisitor.
Reimplemented in osgUtil::Optimizer::FlattenBillboardVisitor, osgUtil::Optimizer::MergeGeometryVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::IntersectionVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, and osgUtil::UpdateVisitor.
Reimplemented in osgUtil::Optimizer::SpatializeGroupsVisitor, osgUtil::Optimizer::MergeGeodesVisitor, osgUtil::Optimizer::RemoveRedundantNodesVisitor, osgUtil::Optimizer::RemoveEmptyNodesVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, and osgSim::InsertImpostorsVisitor.
|
virtual |
|
virtual |
Reimplemented in osgUtil::CullVisitor.
|
virtual |
Reimplemented in osgUtil::CullVisitor.
|
virtual |
Reimplemented in osgUtil::CullVisitor, osgGA::EventVisitor, and osgUtil::UpdateVisitor.
Reimplemented in osgUtil::Optimizer::RemoveRedundantNodesVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, osgAnimation::RigGeometry::FindNearestParentSkeleton, osgGA::EventVisitor, osgUtil::UpdateVisitor, osg::CollectOccludersVisitor, osg::ComputeBoundsVisitor, and osgAnimation::BoneMapVisitor.
Reimplemented in osgUtil::IntersectionVisitor, osgUtil::PickVisitor, and osgUtil::CullVisitor.
|
virtual |
|
virtual |
Reimplemented in osgUtil::Optimizer::CombineStaticTransformsVisitor.
|
virtual |
Reimplemented in osgUtil::Optimizer::CombineLODsVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, osg::CollectOccludersVisitor, and osgSim::InsertImpostorsVisitor.
Reimplemented in osgUtil::Optimizer::FlattenStaticTransformsVisitor, and osgUtil::IntersectionVisitor.
Reimplemented in osgUtil::CullVisitor.
|
virtual |
Reimplemented in osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, and osg::CollectOccludersVisitor.
|
virtual |
Reimplemented in osgUtil::CullVisitor.
|
inlinevirtual |
return the name of the visitor's class type.
Should be defined by derived classes.
|
inline |
Get the handler for database requests.
|
inline |
Get the const handler for database requests.
|
inlinevirtual |
Get the distance of a point from the eye point, distance value in the eye coordinate system.
Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceFromEyePoint(pos) is not implemented than a default value of 0.0 is returned.
Reimplemented in osgUtil::CullVisitor, and osg::CollectOccludersVisitor.
|
inlinevirtual |
Get the distance from a point to the eye point, distance value in local coordinate system.
Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceFromEyePoint(pos) is not implemented then a default value of 0.0 is returned.
Reimplemented in osgUtil::IntersectionVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, and osg::CollectOccludersVisitor.
|
inlinevirtual |
Get the distance from a point to the view point, distance value in local coordinate system.
Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceToViewPoint(pos) is not implemented then a default value of 0.0 is returned.
Reimplemented in osgUtil::CullVisitor, and osg::CollectOccludersVisitor.
|
inlinevirtual |
Get the eye point in local coordinates.
Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement.
Reimplemented in osgUtil::IntersectionVisitor, osgUtil::IntersectVisitor, and osgUtil::CullVisitor.
|
inline |
Get the FrameStamp that this traversal is associated with.
|
inline |
Get the handler for image requests.
|
inline |
Get the const handler for image requests.
|
inline |
Get the NodeMaskOverride mask.
|
inline |
Get the non const NodePath from the top most node applied down to the current Node being visited.
Referenced by osgParticle::ParticleProcessor::getLocalToWorldMatrix(), and osgParticle::ParticleProcessor::getWorldToLocalMatrix().
|
inline |
Get the const NodePath from the top most node applied down to the current Node being visited.
|
inline |
Get the TraversalMask.
|
inline |
Get the traversal mode.
|
inline |
Get the traversal number.
Typically used to denote the frame count.
|
inline |
Get user data.
|
inline |
Get const user data.
|
inlinevirtual |
Get the view point in local coordinates.
Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement.
Reimplemented in osgUtil::CullVisitor.
|
inline |
Get the VisitorType.
|
inlinevirtual |
return the library name/namespapce of the visitor's.
Should be defined by derived classes.
|
inline |
Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..).
Note, the user does not typically call popFromNodePath() as it will be called automatically by the Node::accept() method.
Referenced by osgParticle::PrecipitationEffect::accept(), osgParticle::Emitter::accept(), osgParticle::ParticleEffect::accept(), osgParticle::Program::accept(), and osgParticle::ParticleProcessor::accept().
Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..).
The back of the list will, therefore, be the current node being visited inside the apply(..), and the rest of the list will be the parental sequence of nodes from the top most node applied down the graph to the current node. Note, the user does not typically call pushNodeOnPath() as it will be called automatically by the Node::accept() method.
Referenced by osgParticle::PrecipitationEffect::accept(), osgParticle::Emitter::accept(), osgParticle::ParticleEffect::accept(), osgParticle::Program::accept(), and osgParticle::ParticleProcessor::accept().
|
inlinevirtual |
Method to call to reset visitor.
Useful if your visitor accumulates state during a traversal, and you plan to reuse the visitor. To flush that state for the next traversal: call reset() prior to each traversal.
Reimplemented in osgUtil::Optimizer::TextureAtlasVisitor, osgUtil::Optimizer::FlattenBillboardVisitor, osgUtil::Optimizer::StateVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::VertexCacheMissVisitor, osgUtil::ShaderGenVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgSim::InsertImpostorsVisitor, osgAnimation::LinkVisitor, osg::CollectOccludersVisitor, and osgUtil::GeometryCollector.
|
inline |
Set the handler for database requests.
|
inline |
Set the FrameStamp that this traversal is associated with.
|
inline |
Set the handler for image requests.
|
inline |
Set the NodeMaskOverride mask.
Used in validNodeMask() to determine whether to operate on a node or its subgraph, by OR'ing NodeVisitor::_nodeMaskOverride with the Node's own Node::_nodeMask. Typically used to force on nodes which may have been switched off by their own Node::_nodeMask.
|
inline |
Set the TraversalMask of this NodeVisitor.
The TraversalMask is used by the NodeVisitor::validNodeMask() method to determine whether to operate on a node and its subgraph. validNodeMask() is called automatically in the Node::accept() method before any call to NodeVisitor::apply(), apply() is only ever called if validNodeMask returns true. Note, if NodeVisitor::_traversalMask is 0 then all operations will be switched off for all nodes. Whereas setting both _traversalMask and _nodeMaskOverride to 0xffffffff will allow a visitor to work on all nodes regardless of their own Node::_nodeMask state.
|
inline |
Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
If a NodeVisitor has been attached via setTraverseVisitor() and the new mode is not TRAVERSE_VISITOR then the attached visitor is detached. Default mode is TRAVERSE_NONE.
|
inline |
Set the traversal number.
Typically used to denote the frame count.
|
inline |
Set user data, data must be subclassed from Referenced to allow automatic memory handling.
If your own data isn't directly subclassed from Referenced then create an adapter object which points to your own objects and handles the memory addressing.
|
inline |
Set the VisitorType, used to distinguish different visitors during traversal of the scene, typically used in the Node::traverse() method to select which behaviour to use for different types of traversal/visitors.
Method for handling traversal of a nodes.
If you intend to use the visitor for actively traversing the scene graph then make sure the accept() methods call this method unless they handle traversal directly.
References osg::Node::ascend(), and osg::Node::traverse().
|
inline |
Method to called by Node and its subclass' Node::accept() method, if the result is true it is used to cull operations of nodes and their subgraphs.
Return true if the result of a bit wise and of the NodeVisitor::_traversalMask with the bit or between NodeVistor::_nodeMaskOverride and the Node::_nodeMask. default values for _traversalMask is 0xffffffff, _nodeMaskOverride is 0x0, and osg::Node::_nodeMask is 0xffffffff.
References osg::Node::getNodeMask().
Referenced by osgParticle::PrecipitationEffect::accept(), osgParticle::Emitter::accept(), osgParticle::ParticleEffect::accept(), osgParticle::Program::accept(), and osgParticle::ParticleProcessor::accept().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
![]() | Generated at Tue Sep 4 2012 06:15:28 for the OpenSceneGraph by doxygen 1.8.1.2. |