osg::NodeVisitor Class Reference

#include <NodeVisitor.h>

Inheritance diagram for osg::NodeVisitor:

Collaboration diagram for osg::NodeVisitor:

Classes
class	DatabaseRequestHandler
class	ImageRequestHandler

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()
virtual const NodeVisitor *	asNodeVisitor () const
virtual void	reset ()
void	setVisitorType (VisitorType type)
VisitorType	getVisitorType () const
void	setTraversalNumber (unsigned int fn)
unsigned int	getTraversalNumber () const
void	setFrameStamp (FrameStamp *fs)
const FrameStamp *	getFrameStamp () const
void	setTraversalMask (Node::NodeMask mask)
Node::NodeMask	getTraversalMask () const
void	setNodeMaskOverride (Node::NodeMask mask)
Node::NodeMask	getNodeMaskOverride () const
bool	validNodeMask (const osg::Node &node) const
void	setTraversalMode (TraversalMode mode)
TraversalMode	getTraversalMode () const
void	traverse (Node &node)
void	pushOntoNodePath (Node *node)
void	popFromNodePath ()
NodePath &	getNodePath ()
const NodePath &	getNodePath () const
virtual osg::Vec3	getEyePoint () const
virtual osg::Vec3	getViewPoint () const
virtual float	getDistanceToEyePoint (const Vec3 &, bool) const
virtual float	getDistanceFromEyePoint (const Vec3 &, bool) const
virtual float	getDistanceToViewPoint (const Vec3 &, bool) const
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 (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)
DatabaseRequestHandler *	getDatabaseRequestHandler ()
const DatabaseRequestHandler *	getDatabaseRequestHandler () const
void	setImageRequestHandler (ImageRequestHandler *handler)
ImageRequestHandler *	getImageRequestHandler ()
const ImageRequestHandler *	getImageRequestHandler () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual const char *	className () const =0
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
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)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
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 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
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::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
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

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.

Definition at line 67 of file NodeVisitor.h.

Member Enumeration Documentation

enum osg::NodeVisitor::TraversalMode

Enumerator
TRAVERSE_NONE
TRAVERSE_PARENTS
TRAVERSE_ALL_CHILDREN
TRAVERSE_ACTIVE_CHILDREN

Definition at line 71 of file NodeVisitor.h.

enum osg::NodeVisitor::VisitorType

Enumerator
NODE_VISITOR
UPDATE_VISITOR
EVENT_VISITOR
COLLECT_OCCLUDER_VISITOR
CULL_VISITOR
INTERSECTION_VISITOR

Definition at line 79 of file NodeVisitor.h.

Constructor & Destructor Documentation

osg::NodeVisitor::NodeVisitor

(

TraversalMode

tm = TRAVERSE_NONE

)

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

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

virtual osg::NodeVisitor::~NodeVisitor ( )

virtual

Member Function Documentation

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

virtual

Reimplemented in osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::GLObjectsVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, osgUtil::StateToCompile, and osg::ComputeBoundsVisitor.

Here is the caller graph for this function:

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

virtual

Reimplemented in osg::KdTreeBuilder.

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

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, osgAnimation::LinkVisitor, osgAnimation::BoneMapVisitor, and osgUtil::PrintVisitor.

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

virtual

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, osgUtil::IntersectVisitor, osgUtil::GLObjectsVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::Simplifier, osgUtil::VertexCacheMissVisitor, osgUtil::ShaderGenVisitor, osgUtil::UpdateVisitor, osgDB::SharedStateManager, osgUtil::TriStripVisitor, osgUtil::DisplayRequirementsVisitor, osgUtil::SmoothingVisitor, osgUtil::DrawElementTypeSimplifierVisitor, osgAnimation::LinkVisitor, and osgUtil::GeometryCollector.

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

virtual

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.

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

virtual

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 void osg::NodeVisitor::apply ( ProxyNode &  node )

virtual

Reimplemented in osgUtil::Optimizer::RemoveLoadedProxyNodesVisitor, and osgUtil::Optimizer::FlattenStaticTransformsVisitor.

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

virtual

Reimplemented in osgUtil::IntersectionVisitor, osgUtil::PickVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, and osg::CollectOccludersVisitor.

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

virtual

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

virtual

Reimplemented in osgUtil::CullVisitor.

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

virtual

Reimplemented in osgUtil::CullVisitor.

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

virtual

Reimplemented in osgUtil::CullVisitor, osgGA::EventVisitor, and osgUtil::UpdateVisitor.

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

virtual

Reimplemented in osgUtil::Optimizer::RemoveRedundantNodesVisitor, osgUtil::Optimizer::FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::IntersectionVisitor, osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgAnimation::RigGeometry::FindNearestParentSkeleton, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, osg::CollectOccludersVisitor, osg::ComputeBoundsVisitor, and osgAnimation::BoneMapVisitor.

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

virtual

Reimplemented in osgUtil::IntersectionVisitor, osgUtil::PickVisitor, and osgUtil::CullVisitor.

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

virtual

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

virtual

Reimplemented in osgUtil::Optimizer::CombineStaticTransformsVisitor.

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

virtual

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

virtual

Reimplemented in osgUtil::StatsVisitor, osgUtil::IntersectVisitor, osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, and osg::CollectOccludersVisitor.

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

virtual

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

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.

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

virtual

Reimplemented in osgUtil::Optimizer::FlattenStaticTransformsVisitor, and osgUtil::IntersectionVisitor.

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

virtual

Reimplemented in osgUtil::CullVisitor.

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

virtual

Reimplemented in osgUtil::CullVisitor, osgGA::EventVisitor, osgUtil::UpdateVisitor, and osg::CollectOccludersVisitor.

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

virtual

Reimplemented in osgUtil::CullVisitor.

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.

Definition at line 105 of file NodeVisitor.h.

DatabaseRequestHandler* osg::NodeVisitor::getDatabaseRequestHandler ( )

inline

Get the handler for database requests.

Definition at line 290 of file NodeVisitor.h.

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

inline

Get the const handler for database requests.

Definition at line 293 of file NodeVisitor.h.

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.

Definition at line 230 of file NodeVisitor.h.

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::IntersectVisitor, osgUtil::CullVisitor, and osg::CollectOccludersVisitor.

Definition at line 225 of file NodeVisitor.h.

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.

Definition at line 235 of file NodeVisitor.h.

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, osgUtil::IntersectVisitor, and osgUtil::CullVisitor.

Definition at line 216 of file NodeVisitor.h.

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

inline

Get the FrameStamp that this traversal is associated with.

Definition at line 133 of file NodeVisitor.h.

ImageRequestHandler* osg::NodeVisitor::getImageRequestHandler ( )

inline

Get the handler for image requests.

Definition at line 318 of file NodeVisitor.h.

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

inline

Get the const handler for image requests.

Definition at line 321 of file NodeVisitor.h.

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

inline

Get the NodeMaskOverride mask.

Definition at line 158 of file NodeVisitor.h.

NodePath& osg::NodeVisitor::getNodePath ( )

inline

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

Definition at line 208 of file NodeVisitor.h.

Here is the caller graph for this function:

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

inline

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

Definition at line 212 of file NodeVisitor.h.

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

inline

Get the TraversalMask.

Definition at line 148 of file NodeVisitor.h.

TraversalMode osg::NodeVisitor::getTraversalMode ( ) const

inline

Get the traversal mode.

Definition at line 179 of file NodeVisitor.h.

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

inline

Get the traversal number. Typically used to denote the frame count.

Definition at line 127 of file NodeVisitor.h.

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.

Definition at line 220 of file NodeVisitor.h.

VisitorType osg::NodeVisitor::getVisitorType ( ) const

inline

Get the VisitorType.

Definition at line 121 of file NodeVisitor.h.

Here is the caller graph for this function:

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

Definition at line 97 of file NodeVisitor.h.

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.

Definition at line 204 of file NodeVisitor.h.

Here is the caller graph for this function:

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.

Definition at line 198 of file NodeVisitor.h.

Here is the caller graph for this function:

virtual void osg::NodeVisitor::reset ( )

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.

Definition at line 112 of file NodeVisitor.h.

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

inline

Set the handler for database requests.

Definition at line 287 of file NodeVisitor.h.

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

inline

Set the FrameStamp that this traversal is associated with.

Definition at line 130 of file NodeVisitor.h.

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

inline

Set the handler for image requests.

Definition at line 315 of file NodeVisitor.h.

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.

Definition at line 155 of file NodeVisitor.h.

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.

Definition at line 145 of file NodeVisitor.h.

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.

Definition at line 176 of file NodeVisitor.h.

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

inline

Set the traversal number. Typically used to denote the frame count.

Definition at line 124 of file NodeVisitor.h.

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.

Definition at line 118 of file NodeVisitor.h.

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.

Definition at line 185 of file NodeVisitor.h.

Here is the call graph for this function:

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.

Definition at line 166 of file NodeVisitor.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ref_ptr<DatabaseRequestHandler> osg::NodeVisitor::_databaseRequestHandler

protected

Definition at line 338 of file NodeVisitor.h.

ref_ptr<FrameStamp> osg::NodeVisitor::_frameStamp

protected

Definition at line 330 of file NodeVisitor.h.

ref_ptr<ImageRequestHandler> osg::NodeVisitor::_imageRequestHandler

protected

Definition at line 339 of file NodeVisitor.h.

Node::NodeMask osg::NodeVisitor::_nodeMaskOverride

protected

Definition at line 334 of file NodeVisitor.h.

NodePath osg::NodeVisitor::_nodePath

protected

Definition at line 336 of file NodeVisitor.h.

Node::NodeMask osg::NodeVisitor::_traversalMask

protected

Definition at line 333 of file NodeVisitor.h.

TraversalMode osg::NodeVisitor::_traversalMode

protected

Definition at line 332 of file NodeVisitor.h.

unsigned int osg::NodeVisitor::_traversalNumber

protected

Definition at line 328 of file NodeVisitor.h.

VisitorType osg::NodeVisitor::_visitorType

protected

Definition at line 327 of file NodeVisitor.h.

---

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

• osg_head/include/osg/NodeVisitor.h