class SG_EXPORT osg::NodeVisitor

Visitor for type safe operations on osg::Node's.

Inheritance:

Public Classes

[more]enum TraversalMode
[more]enum VisitorType
class DatabaseRequestHandler: public osg::Referenced
callback for managing database paging, such as generated by PagedLOD nodes

Public Methods

[more] NodeVisitor(TraversalMode tm=TRAVERSE_NONE)
[more] NodeVisitor(VisitorType type, TraversalMode tm=TRAVERSE_NONE)
[more]virtual ~NodeVisitor()
[more]virtual void reset()
Method to call to reset visitor.
[more]inline void setVisitorType(VisitorType type)
Set the VisitorType, used to distingush 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]inline VisitorType getVisitorType() const
Get the VisitorType
[more]inline void setTraversalNumber(int fn)
Set the traversal number.
[more]inline int getTraversalNumber() const
Get the traversal number.
[more]inline void setFrameStamp(FrameStamp* fs)
Set the FrameStamp that this traversal is assoicated with
[more]inline const FrameStamp* getFrameStamp() const
Get the FrameStamp that this traversal is assoicated with
[more]inline void setTraversalMask(Node::NodeMask mask)
Set the TraversalMask of this NodeVisitor.
[more]inline Node::NodeMask getTraversalMask() const
Get the TraversalMask
[more]inline void setNodeMaskOverride(Node::NodeMask mask)
Set the NodeMaskOverride mask.
[more]inline Node::NodeMask getNodeMaskOverride() const
Get the NodeMaskOverride mask
[more]inline bool validNodeMask(const osg::Node& node) const
Method to called by Node and its subclass' Node::accept() method, if the result is true to be used to cull operations of nodes and their subgraphs.
[more]inline void setTraversalMode(TraversalMode mode)
Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
[more]inline TraversalMode getTraversalMode() const
Get the traversal mode
[more]inline void setUserData(Referenced* obj)
Set user data, data must be subclased from Referenced to allow automatic memory handling.
[more]inline Referenced* getUserData()
Get user data
[more]inline const Referenced* getUserData() const
Get const user data
[more]inline void traverse(Node& node)
Method for handling traversal of a nodes.
[more]inline void pushOntoNodePath(Node* node)
Method called by osg::Node::accept() method before a call the NodeVisitor::apply().
[more]inline void popFromNodePath()
Method callby osg::Node::accept() method after a call the 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 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 void apply(Node& node)
[more]virtual void apply(Geode& node)
[more]virtual void apply(Billboard& node)
[more]virtual void apply(Group& node)
[more]virtual void apply(Projection& node)
[more]virtual void apply(CoordinateSystemNode& node)
[more]virtual void apply(ClipNode& node)
[more]virtual void apply(TexGenNode& node)
[more]virtual void apply(LightSource& node)
[more]virtual void apply(Transform& node)
[more]virtual void apply(MatrixTransform& node)
[more]virtual void apply(PositionAttitudeTransform& node)
[more]virtual void apply(Switch& node)
[more]virtual void apply(Sequence& node)
[more]virtual void apply(LOD& node)
[more]virtual void apply(PagedLOD& node)
[more]virtual void apply(Impostor& node)
[more]virtual void apply(ClearNode& node)
[more]virtual void apply(OccluderNode& node)
[more]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

Protected Fields

[more]VisitorType _visitorType
[more]int _traversalNumber
[more]ref_ptr<FrameStamp> _frameStamp
[more]TraversalMode _traversalMode
[more]Node::NodeMask _traversalMask
[more]Node::NodeMask _nodeMaskOverride
[more]NodePath _nodePath
[more]ref_ptr<Referenced> _userData
[more]ref_ptr<DatabaseRequestHandler> _databaseRequestHandler

Inherited from Referenced:

Public Methods

oinline Referenced& operator = (const Referenced&)
ostatic void setDeleteHandler(DeleteHandler* handler)
ostatic DeleteHandler* getDeleteHandler()
oinline void ref() const
oinline void unref_nodelete() const
oinline int referenceCount() const
oinline void unref() const

Protected Fields

omutable OpenThreads::Mutex _refMutex
omutable int _refCount

Documentation

Visitor for type safe operations on osg::Node's. 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 called 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.
oenum TraversalMode

o TRAVERSE_NONE

o TRAVERSE_PARENTS

o TRAVERSE_ALL_CHILDREN

o TRAVERSE_ACTIVE_CHILDREN

oenum VisitorType

o NODE_VISITOR

o UPDATE_VISITOR

o COLLECT_OCCLUDER_VISITOR

o CULL_VISITOR

o NodeVisitor(TraversalMode tm=TRAVERSE_NONE)

o NodeVisitor(VisitorType type, TraversalMode tm=TRAVERSE_NONE)

ovirtual ~NodeVisitor()

ovirtual void reset()
Method to call to reset visitor. Useful for your visitor accumulates state during a traversal, and you plan to reuse the visitor. To flush that state for the next traversal than call reset() prior to each traversal.

oinline void setVisitorType(VisitorType type)
Set the VisitorType, used to distingush 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

oinline VisitorType getVisitorType() const
Get the VisitorType

oinline void setTraversalNumber(int fn)
Set the traversal number. Typically used to denote the frame count.

oinline int getTraversalNumber() const
Get the traversal number. Typically used to denote the frame count.

oinline void setFrameStamp(FrameStamp* fs)
Set the FrameStamp that this traversal is assoicated with

oinline const FrameStamp* getFrameStamp() const
Get the FrameStamp that this traversal is assoicated with

oinline void setTraversalMask(Node::NodeMask mask)
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 automaticaly 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 swithced 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.

oinline Node::NodeMask getTraversalMask() const
Get the TraversalMask

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

oinline Node::NodeMask getNodeMaskOverride() const
Get the NodeMaskOverride mask

oinline bool validNodeMask(const osg::Node& node) const
Method to called by Node and its subclass' Node::accept() method, if the result is true to be 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.

oinline void setTraversalMode(TraversalMode mode)
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.

oinline TraversalMode getTraversalMode() const
Get the traversal mode

oinline void setUserData(Referenced* obj)
Set user data, data must be subclased from Referenced to allow automatic memory handling. If you own data isn't directly subclassed from Referenced then create and adapter object which points to your own objects and handles the memory addressing.

oinline Referenced* getUserData()
Get user data

oinline const Referenced* getUserData() const
Get const user data

oinline void traverse(Node& node)
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.

oinline void pushOntoNodePath(Node* node)
Method called by osg::Node::accept() method before a call 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.

oinline void popFromNodePath()
Method callby osg::Node::accept() method after a call the NodeVisitor::apply(). Note, the user does not typically call pushNodeOnPath() as it will be called automatically by the Node::accept() method.

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

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

ovirtual osg::Vec3 getEyePoint() const
Get the eye point in local coordinates. Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement.

ovirtual float getDistanceToEyePoint(const Vec3& , bool ) const
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 getDistianceFromEyePoint(pos) is not implmented than a default value of 0.0 is returned.

ovirtual float getDistanceFromEyePoint(const Vec3& , bool ) const
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 getDistianceFromEyePoint(pos) is not implmented than a default value of 0.0 is returned.

ovirtual void apply(Node& node)

ovirtual void apply(Geode& node)

ovirtual void apply(Billboard& node)

ovirtual void apply(Group& node)

ovirtual void apply(Projection& node)

ovirtual void apply(CoordinateSystemNode& node)

ovirtual void apply(ClipNode& node)

ovirtual void apply(TexGenNode& node)

ovirtual void apply(LightSource& node)

ovirtual void apply(Transform& node)

ovirtual void apply(MatrixTransform& node)

ovirtual void apply(PositionAttitudeTransform& node)

ovirtual void apply(Switch& node)

ovirtual void apply(Sequence& node)

ovirtual void apply(LOD& node)

ovirtual void apply(PagedLOD& node)

ovirtual void apply(Impostor& node)

ovirtual void apply(ClearNode& node)

ovirtual void apply(OccluderNode& node)

ovoid setDatabaseRequestHandler(DatabaseRequestHandler* handler)
Set the handler for database requests

oDatabaseRequestHandler* getDatabaseRequestHandler()
Get the handler for database requests

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

oVisitorType _visitorType

oint _traversalNumber

oref_ptr<FrameStamp> _frameStamp

oTraversalMode _traversalMode

oNode::NodeMask _traversalMask

oNode::NodeMask _nodeMaskOverride

oNodePath _nodePath

oref_ptr<Referenced> _userData

oref_ptr<DatabaseRequestHandler> _databaseRequestHandler

Direct child classes:
CollectOccludersVisitor

Alphabetic index HTML hierarchy of classes or Java


This page was generated with the help of DOC++.