OpenSceneGraph
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
osg::NodeVisitor Class Reference

Visitor for type safe operations on osg::Nodes. More...

Inheritance diagram for osg::NodeVisitor:
Inheritance graph
[legend]

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, INTERSECTION_VISITOR
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 NodeVisitor (TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (const NodeVisitor &nv, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual ~NodeVisitor ()
 
 META_Object (osg, NodeVisitor) virtual NodeVisitor *asNodeVisitor()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual osgUtil::UpdateVisitorasUpdateVisitor ()
 Convert 'this' into a osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0. More...
 
virtual const osgUtil::UpdateVisitorasUpdateVisitor () const
 convert 'const this' into a const osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0. More...
 
virtual osgUtil::CullVisitorasCullVisitor ()
 Convert 'this' into a osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0. More...
 
virtual const osgUtil::CullVisitorasCullVisitor () const
 convert 'const this' into a const osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0. More...
 
virtual osgGA::EventVisitorasEventVisitor ()
 Convert 'this' into a osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0. More...
 
virtual const osgGA::EventVisitorasEventVisitor () const
 convert 'const this' into a const osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0. More...
 
virtual osgUtil::IntersectionVisitorasIntersectionVisitor ()
 Convert 'this' into a osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0. More...
 
virtual const osgUtil::IntersectionVisitorasIntersectionVisitor () const
 convert 'const this' into a const osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0. More...
 
virtual osg::CullStackasCullStack ()
 Convert 'this' into a osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0. More...
 
virtual const osg::CullStackasCullStack () const
 convert 'const this' into a const osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0. More...
 
virtual void reset ()
 Method to call to reset visitor. More...
 
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. More...
 
VisitorType getVisitorType () const
 Get the VisitorType. More...
 
void setTraversalNumber (unsigned int fn)
 Set the traversal number. More...
 
unsigned int getTraversalNumber () const
 Get the traversal number. More...
 
void setFrameStamp (FrameStamp *fs)
 Set the FrameStamp that this traversal is associated with. More...
 
const FrameStampgetFrameStamp () const
 Get the FrameStamp that this traversal is associated with. More...
 
void setTraversalMask (Node::NodeMask mask)
 Set the TraversalMask of this NodeVisitor. More...
 
Node::NodeMask getTraversalMask () const
 Get the TraversalMask. More...
 
void setNodeMaskOverride (Node::NodeMask mask)
 Set the NodeMaskOverride mask. More...
 
Node::NodeMask getNodeMaskOverride () const
 Get the NodeMaskOverride mask. More...
 
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. More...
 
void setTraversalMode (TraversalMode mode)
 Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse. More...
 
TraversalMode getTraversalMode () const
 Get the traversal mode. More...
 
void setValueMap (ValueMap *ps)
 Set the ValueMap used to store Values that can be reused over a series of traversals. More...
 
ValueMapgetValueMap ()
 Get the ValueMap. More...
 
const ValueMapgetValueMap () const
 Get the ValueMap. More...
 
ValueMapgetOrCreateValueMap ()
 Get the ValueMap. More...
 
void setValueStack (ValueStack *ps)
 Set the ValueStack used to stack Values during traversal. More...
 
ValueStackgetValueStack ()
 Get the ValueStack. More...
 
const ValueStackgetValueStack () const
 Get the const ValueStack. More...
 
ValueStackgetOrCreateValueStack ()
 Get the ValueStack. More...
 
void traverse (Node &node)
 Method for handling traversal of a nodes. More...
 
void pushOntoNodePath (Node *node)
 Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..). More...
 
void popFromNodePath ()
 Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..). More...
 
NodePathgetNodePath ()
 Get the non const NodePath from the top most node applied down to the current Node being visited. More...
 
const NodePathgetNodePath () const
 Get the const NodePath from the top most node applied down to the current Node being visited. More...
 
virtual osg::Vec3 getEyePoint () const
 Get the eye point in local coordinates. More...
 
virtual osg::Vec3 getViewPoint () const
 Get the view point in local coordinates. More...
 
virtual float getDistanceToEyePoint (const Vec3 &, bool) const
 Get the distance from a point to the eye point, distance value in local coordinate system. More...
 
virtual float getDistanceFromEyePoint (const Vec3 &, bool) const
 Get the distance of a point from the eye point, distance value in the eye coordinate system. More...
 
virtual float getDistanceToViewPoint (const Vec3 &, bool) const
 Get the distance from a point to the view point, distance value in local coordinate system. More...
 
virtual void apply (Drawable &drawable)
 
virtual void apply (Geometry &geometry)
 
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 (AutoTransform &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. More...
 
DatabaseRequestHandlergetDatabaseRequestHandler ()
 Get the handler for database requests. More...
 
const DatabaseRequestHandlergetDatabaseRequestHandler () const
 Get the const handler for database requests. More...
 
void setImageRequestHandler (ImageRequestHandler *handler)
 Set the handler for image requests. More...
 
ImageRequestHandlergetImageRequestHandler ()
 Get the handler for image requests. More...
 
const ImageRequestHandlergetImageRequestHandler () const
 Get the const handler for image requests. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
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. More...
 
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. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
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 More...
 
- 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. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Attributes

VisitorType _visitorType
 
unsigned int _traversalNumber
 
ref_ptr< FrameStamp_frameStamp
 
TraversalMode _traversalMode
 
Node::NodeMask _traversalMask
 
Node::NodeMask _nodeMaskOverride
 
NodePath _nodePath
 
ref_ptr< DatabaseRequestHandler_databaseRequestHandler
 
ref_ptr< ImageRequestHandler_imageRequestHandler
 
osg::ref_ptr< ValueMap_valueMap
 
osg::ref_ptr< ValueStack_valueStack
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

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.

Member Enumeration Documentation

◆ TraversalMode

Enumerator
TRAVERSE_NONE 
TRAVERSE_PARENTS 
TRAVERSE_ALL_CHILDREN 
TRAVERSE_ACTIVE_CHILDREN 

◆ VisitorType

Enumerator
NODE_VISITOR 
UPDATE_VISITOR 
EVENT_VISITOR 
COLLECT_OCCLUDER_VISITOR 
CULL_VISITOR 
INTERSECTION_VISITOR 

Constructor & Destructor Documentation

◆ NodeVisitor() [1/3]

osg::NodeVisitor::NodeVisitor ( TraversalMode  tm = TRAVERSE_NONE)

◆ NodeVisitor() [2/3]

osg::NodeVisitor::NodeVisitor ( VisitorType  type,
TraversalMode  tm = TRAVERSE_NONE 
)

◆ NodeVisitor() [3/3]

osg::NodeVisitor::NodeVisitor ( const NodeVisitor nv,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

◆ ~NodeVisitor()

virtual osg::NodeVisitor::~NodeVisitor ( )
virtual

Member Function Documentation

◆ apply() [1/25]

virtual void osg::NodeVisitor::apply ( Drawable drawable)
virtual

◆ apply() [2/25]

virtual void osg::NodeVisitor::apply ( Geometry geometry)
virtual

◆ apply() [3/25]

virtual void osg::NodeVisitor::apply ( Node node)
virtual

◆ apply() [4/25]

virtual void osg::NodeVisitor::apply ( Geode node)
virtual

◆ apply() [5/25]

virtual void osg::NodeVisitor::apply ( Billboard node)
virtual

◆ apply() [6/25]

virtual void osg::NodeVisitor::apply ( Group node)
virtual

◆ apply() [7/25]

virtual void osg::NodeVisitor::apply ( ProxyNode node)
virtual

◆ apply() [8/25]

virtual void osg::NodeVisitor::apply ( Projection node)
virtual

◆ apply() [9/25]

virtual void osg::NodeVisitor::apply ( CoordinateSystemNode node)
virtual

◆ apply() [10/25]

virtual void osg::NodeVisitor::apply ( ClipNode node)
virtual

Reimplemented in osgUtil::CullVisitor.

◆ apply() [11/25]

virtual void osg::NodeVisitor::apply ( TexGenNode node)
virtual

Reimplemented in osgUtil::CullVisitor.

◆ apply() [12/25]

virtual void osg::NodeVisitor::apply ( LightSource node)
virtual

◆ apply() [13/25]

virtual void osg::NodeVisitor::apply ( Transform node)
virtual

◆ apply() [14/25]

virtual void osg::NodeVisitor::apply ( Camera node)
virtual

◆ apply() [15/25]

virtual void osg::NodeVisitor::apply ( CameraView node)
virtual

◆ apply() [16/25]

virtual void osg::NodeVisitor::apply ( MatrixTransform node)
virtual

◆ apply() [17/25]

virtual void osg::NodeVisitor::apply ( PositionAttitudeTransform node)
virtual

◆ apply() [18/25]

virtual void osg::NodeVisitor::apply ( AutoTransform node)
virtual

◆ apply() [19/25]

virtual void osg::NodeVisitor::apply ( Switch node)
virtual

◆ apply() [20/25]

virtual void osg::NodeVisitor::apply ( Sequence node)
virtual

◆ apply() [21/25]

virtual void osg::NodeVisitor::apply ( LOD node)
virtual

◆ apply() [22/25]

virtual void osg::NodeVisitor::apply ( PagedLOD node)
virtual

◆ apply() [23/25]

virtual void osg::NodeVisitor::apply ( ClearNode node)
virtual

Reimplemented in osgUtil::CullVisitor.

◆ apply() [24/25]

virtual void osg::NodeVisitor::apply ( OccluderNode node)
virtual

◆ apply() [25/25]

virtual void osg::NodeVisitor::apply ( OcclusionQueryNode node)
virtual

Reimplemented in osgUtil::CullVisitor.

◆ asCullStack() [1/2]

virtual osg::CullStack* osg::NodeVisitor::asCullStack ( )
inlinevirtual

Convert 'this' into a osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0.

Equivalent to dynamic_cast<osg::CullStack*>(this).

Reimplemented in osgUtil::CullVisitor.

◆ asCullStack() [2/2]

virtual const osg::CullStack* osg::NodeVisitor::asCullStack ( ) const
inlinevirtual

convert 'const this' into a const osg::CullStack pointer if Object is a osg::CullStack, otherwise return 0.

Equivalent to dynamic_cast<const osg::CullStack*>(this).

Reimplemented in osgUtil::CullVisitor.

◆ asCullVisitor() [1/2]

virtual osgUtil::CullVisitor* osg::NodeVisitor::asCullVisitor ( )
inlinevirtual

Convert 'this' into a osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0.

Equivalent to dynamic_cast<osgUtil::CullVisitor*>(this).

◆ asCullVisitor() [2/2]

virtual const osgUtil::CullVisitor* osg::NodeVisitor::asCullVisitor ( ) const
inlinevirtual

convert 'const this' into a const osgUtil::CullVisitor pointer if Object is a osgUtil::CullVisitor, otherwise return 0.

Equivalent to dynamic_cast<const osgUtil::CullVisitor*>(this).

Reimplemented in osgUtil::CullVisitor.

◆ asEventVisitor() [1/2]

virtual osgGA::EventVisitor* osg::NodeVisitor::asEventVisitor ( )
inlinevirtual

Convert 'this' into a osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0.

Equivalent to dynamic_cast<osgGA::EventVisitor*>(this).

◆ asEventVisitor() [2/2]

virtual const osgGA::EventVisitor* osg::NodeVisitor::asEventVisitor ( ) const
inlinevirtual

convert 'const this' into a const osgGA::EventVisitor pointer if Object is a osgGA::EventVisitor, otherwise return 0.

Equivalent to dynamic_cast<const osgGA::EventVisitor*>(this).

Reimplemented in osgGA::EventVisitor.

◆ asIntersectionVisitor() [1/2]

virtual osgUtil::IntersectionVisitor* osg::NodeVisitor::asIntersectionVisitor ( )
inlinevirtual

Convert 'this' into a osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0.

Equivalent to dynamic_cast<osgUtil::IntersectionVisitor*>(this).

◆ asIntersectionVisitor() [2/2]

virtual const osgUtil::IntersectionVisitor* osg::NodeVisitor::asIntersectionVisitor ( ) const
inlinevirtual

convert 'const this' into a const osgUtil::IntersectionVisitor pointer if Object is a IntersectionVisitor, otherwise return 0.

Equivalent to dynamic_cast<const osgUtil::IntersectionVisitor*>(this).

Reimplemented in osgUtil::IntersectionVisitor.

◆ asNodeVisitor()

virtual const NodeVisitor* osg::NodeVisitor::asNodeVisitor ( ) const
inlinevirtual

convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.

Equivalent to dynamic_cast<const NodeVisitor*>(this).

Reimplemented from osg::Object.

◆ asUpdateVisitor() [1/2]

virtual osgUtil::UpdateVisitor* osg::NodeVisitor::asUpdateVisitor ( )
inlinevirtual

Convert 'this' into a osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.

Equivalent to dynamic_cast<osgUtil::UpdateVisitor*>(this).

◆ asUpdateVisitor() [2/2]

virtual const osgUtil::UpdateVisitor* osg::NodeVisitor::asUpdateVisitor ( ) const
inlinevirtual

convert 'const this' into a const osgUtil::UpdateVisitor pointer if Object is a osgUtil::UpdateVisitor, otherwise return 0.

Equivalent to dynamic_cast<const osgUtil::UpdateVisitor*>(this).

Reimplemented in osgUtil::UpdateVisitor.

◆ getDatabaseRequestHandler() [1/2]

DatabaseRequestHandler* osg::NodeVisitor::getDatabaseRequestHandler ( )
inline

Get the handler for database requests.

◆ getDatabaseRequestHandler() [2/2]

const DatabaseRequestHandler* osg::NodeVisitor::getDatabaseRequestHandler ( ) const
inline

Get the const handler for database requests.

◆ getDistanceFromEyePoint()

virtual float osg::NodeVisitor::getDistanceFromEyePoint ( const Vec3 ,
bool   
) const
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.

◆ getDistanceToEyePoint()

virtual float osg::NodeVisitor::getDistanceToEyePoint ( const Vec3 ,
bool   
) const
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::CullVisitor, and osg::CollectOccludersVisitor.

◆ getDistanceToViewPoint()

virtual float osg::NodeVisitor::getDistanceToViewPoint ( const Vec3 ,
bool   
) const
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.

◆ getEyePoint()

virtual osg::Vec3 osg::NodeVisitor::getEyePoint ( ) const
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, and osgUtil::CullVisitor.

◆ getFrameStamp()

const FrameStamp* osg::NodeVisitor::getFrameStamp ( ) const
inline

Get the FrameStamp that this traversal is associated with.

◆ getImageRequestHandler() [1/2]

ImageRequestHandler* osg::NodeVisitor::getImageRequestHandler ( )
inline

Get the handler for image requests.

◆ getImageRequestHandler() [2/2]

const ImageRequestHandler* osg::NodeVisitor::getImageRequestHandler ( ) const
inline

Get the const handler for image requests.

◆ getNodeMaskOverride()

Node::NodeMask osg::NodeVisitor::getNodeMaskOverride ( ) const
inline

Get the NodeMaskOverride mask.

◆ getNodePath() [1/2]

NodePath& osg::NodeVisitor::getNodePath ( )
inline

Get the non const NodePath from the top most node applied down to the current Node being visited.

◆ getNodePath() [2/2]

const NodePath& osg::NodeVisitor::getNodePath ( ) const
inline

Get the const NodePath from the top most node applied down to the current Node being visited.

◆ getOrCreateValueMap()

ValueMap* osg::NodeVisitor::getOrCreateValueMap ( )
inline

Get the ValueMap.

◆ getOrCreateValueStack()

ValueStack* osg::NodeVisitor::getOrCreateValueStack ( )
inline

◆ getTraversalMask()

Node::NodeMask osg::NodeVisitor::getTraversalMask ( ) const
inline

Get the TraversalMask.

◆ getTraversalMode()

TraversalMode osg::NodeVisitor::getTraversalMode ( ) const
inline

Get the traversal mode.

◆ getTraversalNumber()

unsigned int osg::NodeVisitor::getTraversalNumber ( ) const
inline

Get the traversal number.

Typically used to denote the frame count.

◆ getValueMap() [1/2]

ValueMap* osg::NodeVisitor::getValueMap ( )
inline

Get the ValueMap.

◆ getValueMap() [2/2]

const ValueMap* osg::NodeVisitor::getValueMap ( ) const
inline

Get the ValueMap.

◆ getValueStack() [1/2]

ValueStack* osg::NodeVisitor::getValueStack ( )
inline

Get the ValueStack.

◆ getValueStack() [2/2]

const ValueStack* osg::NodeVisitor::getValueStack ( ) const
inline

Get the const ValueStack.

◆ getViewPoint()

virtual osg::Vec3 osg::NodeVisitor::getViewPoint ( ) const
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.

◆ getVisitorType()

VisitorType osg::NodeVisitor::getVisitorType ( ) const
inline

Get the VisitorType.

Referenced by osgAnimation::UpdateUniform< osg::Vec4f >::operator()().

◆ META_Object()

osg::NodeVisitor::META_Object ( osg  ,
NodeVisitor   
)
inline

Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.

Equivalent to dynamic_cast<NodeVisitor*>(this).

◆ popFromNodePath()

void osg::NodeVisitor::popFromNodePath ( )
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().

◆ pushOntoNodePath()

void osg::NodeVisitor::pushOntoNodePath ( Node node)
inline

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

◆ reset()

virtual void osg::NodeVisitor::reset ( )
inlinevirtual

◆ setDatabaseRequestHandler()

void osg::NodeVisitor::setDatabaseRequestHandler ( DatabaseRequestHandler handler)
inline

Set the handler for database requests.

◆ setFrameStamp()

void osg::NodeVisitor::setFrameStamp ( FrameStamp fs)
inline

Set the FrameStamp that this traversal is associated with.

◆ setImageRequestHandler()

void osg::NodeVisitor::setImageRequestHandler ( ImageRequestHandler handler)
inline

Set the handler for image requests.

◆ setNodeMaskOverride()

void osg::NodeVisitor::setNodeMaskOverride ( Node::NodeMask  mask)
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.

◆ setTraversalMask()

void osg::NodeVisitor::setTraversalMask ( Node::NodeMask  mask)
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.

◆ setTraversalMode()

void osg::NodeVisitor::setTraversalMode ( TraversalMode  mode)
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.

◆ setTraversalNumber()

void osg::NodeVisitor::setTraversalNumber ( unsigned int  fn)
inline

Set the traversal number.

Typically used to denote the frame count.

◆ setValueMap()

void osg::NodeVisitor::setValueMap ( ValueMap ps)
inline

Set the ValueMap used to store Values that can be reused over a series of traversals.

◆ setValueStack()

void osg::NodeVisitor::setValueStack ( ValueStack ps)
inline

Set the ValueStack used to stack Values during traversal.

◆ setVisitorType()

void osg::NodeVisitor::setVisitorType ( VisitorType  type)
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.

◆ traverse()

void osg::NodeVisitor::traverse ( Node node)
inline

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

◆ validNodeMask()

bool osg::NodeVisitor::validNodeMask ( const osg::Node node) const
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().

Member Data Documentation

◆ _databaseRequestHandler

ref_ptr<DatabaseRequestHandler> osg::NodeVisitor::_databaseRequestHandler
protected

◆ _frameStamp

ref_ptr<FrameStamp> osg::NodeVisitor::_frameStamp
protected

◆ _imageRequestHandler

ref_ptr<ImageRequestHandler> osg::NodeVisitor::_imageRequestHandler
protected

◆ _nodeMaskOverride

Node::NodeMask osg::NodeVisitor::_nodeMaskOverride
protected

◆ _nodePath

NodePath osg::NodeVisitor::_nodePath
protected

◆ _traversalMask

Node::NodeMask osg::NodeVisitor::_traversalMask
protected

◆ _traversalMode

TraversalMode osg::NodeVisitor::_traversalMode
protected

◆ _traversalNumber

unsigned int osg::NodeVisitor::_traversalNumber
protected

◆ _valueMap

osg::ref_ptr<ValueMap> osg::NodeVisitor::_valueMap
protected

◆ _valueStack

osg::ref_ptr<ValueStack> osg::NodeVisitor::_valueStack
protected

◆ _visitorType

VisitorType osg::NodeVisitor::_visitorType
protected

The documentation for this class was generated from the following file: