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

Inheritance diagram for osg::NodeVisitor:

[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 NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, 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 FrameStamp *	getFrameStamp () 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	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...

NodePath &	getNodePath ()
	Get the non const NodePath from the top most node applied down to the current Node being visited. More...

const NodePath &	getNodePath () 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 (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...

DatabaseRequestHandler *	getDatabaseRequestHandler ()
	Get the handler for database requests. More...

const DatabaseRequestHandler *	getDatabaseRequestHandler () const
	Get the const handler for database requests. More...

void	setImageRequestHandler (ImageRequestHandler *handler)
	Set the handler for image requests. More...

ImageRequestHandler *	getImageRequestHandler ()
	Get the handler for image requests. More...

const ImageRequestHandler *	getImageRequestHandler () 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 Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () 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 Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

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. 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 Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () 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)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () 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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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

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 ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	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

enum osg::NodeVisitor::TraversalMode

Enumerator
TRAVERSE_NONE
TRAVERSE_PARENTS
TRAVERSE_ALL_CHILDREN
TRAVERSE_ACTIVE_CHILDREN

enum osg::NodeVisitor::VisitorType

Enumerator
NODE_VISITOR
UPDATE_VISITOR
EVENT_VISITOR
COLLECT_OCCLUDER_VISITOR
CULL_VISITOR
INTERSECTION_VISITOR

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.

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

virtual

Reimplemented in osg::KdTreeBuilder.

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

virtual

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

virtual

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, osgUtil::CullVisitor, osgAnimation::RigGeometry::FindNearestParentSkeleton, 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.

DatabaseRequestHandler* osg::NodeVisitor::getDatabaseRequestHandler ( )

inline

Get the handler for database requests.

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

inline

Get the const handler for database requests.

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.

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.

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.

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.

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

inline

Get the FrameStamp that this traversal is associated with.

ImageRequestHandler* osg::NodeVisitor::getImageRequestHandler ( )

inline

Get the handler for image requests.

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

inline

Get the const handler for image requests.

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

inline

Get the NodeMaskOverride mask.

NodePath& osg::NodeVisitor::getNodePath ( )

inline

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

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

inline

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

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

inline

Get the TraversalMask.

TraversalMode osg::NodeVisitor::getTraversalMode ( ) const

inline

Get the traversal mode.

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

inline

Get the traversal number.

Typically used to denote the frame count.

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.

VisitorType osg::NodeVisitor::getVisitorType ( ) const

inline

Get the VisitorType.

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

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.

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.

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.

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

inline

Set the handler for database requests.

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

inline

Set the FrameStamp that this traversal is associated with.

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

inline

Set the handler for image requests.

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.

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.

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.

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

inline

Set the traversal number.

Typically used to denote the frame count.

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.

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.

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.

Member Data Documentation

ref_ptr<DatabaseRequestHandler> osg::NodeVisitor::_databaseRequestHandler

protected

ref_ptr<FrameStamp> osg::NodeVisitor::_frameStamp

protected

ref_ptr<ImageRequestHandler> osg::NodeVisitor::_imageRequestHandler

protected

Node::NodeMask osg::NodeVisitor::_nodeMaskOverride

protected

NodePath osg::NodeVisitor::_nodePath

protected

Node::NodeMask osg::NodeVisitor::_traversalMask

protected

TraversalMode osg::NodeVisitor::_traversalMode

protected

unsigned int osg::NodeVisitor::_traversalNumber

protected

VisitorType osg::NodeVisitor::_visitorType

protected

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

osg/NodeVisitor

Classes

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation