Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::NodeVisitor Class Reference

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

Inheritance diagram for osg::NodeVisitor:

Inheritance graph
[legend]
List of all members.

Public Types

enum  TraversalMode {
  TRAVERSE_NONE, TRAVERSE_PARENTS, TRAVERSE_ALL_CHILDREN, TRAVERSE_ACTIVE_CHILDREN,
  TRAVERSE_VISITOR
}
enum  VisitorType { NODE_VISITOR = 0, APP_VISITOR, COLLECT_OCCLUDER_VISITOR, CULL_VISITOR }

Public Methods

 NodeVisitor (TraversalMode tm=TRAVERSE_NONE)
 NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE)
virtual ~NodeVisitor ()
virtual void reset ()
 Method to call to reset visitor.

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.

VisitorType getVisitorType () const
 Get the VisitorType.

void setTraversalNumber (const int fn)
 Set the traversal number.

const int getTraversalNumber () const
 Get the traversal number.

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

const FrameStampgetFrameStamp () const
 Get the FrameStamp that this traversal is assoicated with.

void setTraversalMask (const Node::NodeMask mask)
 Set the TraversalMask of this NodeVisitor.

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

void setNodeMaskOverride (const Node::NodeMask mask)
 Set the NodeMaskOverride mask.

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

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

void setTraversalMode (const TraversalMode mode)
 Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.

const TraversalMode getTraversalMode () const
 Get the traversal mode.

void setTraversalVisitor (NodeVisitor *nv)
 Set a visitor to handle traversal.

NodeVisitor * getTraversalVisitor ()
 Get the traversal visitor, returns NULL if none is attached.

void traverse (Node &node)
 Method for handling traversal of a nodes.

void pushOntoNodePath (Node *node)
 Method called by osg::Node::accept() method before a call the NodeVisitor::apply(..).

void popFromNodePath ()
 Method callby osg::Node::accept() method after a call the NodeVisitor::apply(..).

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

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

const bool getLocalToWorldMatrix (Matrix &matrix, Node *node)
 Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u.

const bool getWorldToLocalMatrix (Matrix &matrix, Node *node)
 Get the World To Local Matrix from the NodePath for specified Transform::Mode.

virtual void apply (Node &node)
virtual void apply (Geode &node)
virtual void apply (Billboard &node)
virtual void apply (Group &node)
virtual void apply (Projection &node)
virtual void apply (ClipNode &node)
virtual void apply (LightSource &node)
virtual void apply (Transform &node)
virtual void apply (DOFTransform &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 (Impostor &node)
virtual void apply (ClearNode &node)
virtual void apply (OccluderNode &node)

Protected Attributes

VisitorType _visitorType
int _traversalNumber
ref_ptr< FrameStamp_frameStamp
ref_ptr< NodeVisitor > _traversalVisitor
TraversalMode _traversalMode
Node::NodeMask _traversalMask
Node::NodeMask _nodeMaskOverride
NodePath _nodePath

Detailed Description

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.


Member Enumeration Documentation

enum osg::NodeVisitor::TraversalMode
 

Enumeration values:
TRAVERSE_NONE 
TRAVERSE_PARENTS 
TRAVERSE_ALL_CHILDREN 
TRAVERSE_ACTIVE_CHILDREN 
TRAVERSE_VISITOR 

enum osg::NodeVisitor::VisitorType
 

Enumeration values:
NODE_VISITOR 
APP_VISITOR 
COLLECT_OCCLUDER_VISITOR 
CULL_VISITOR 


Constructor & Destructor Documentation

osg::NodeVisitor::NodeVisitor TraversalMode    tm = TRAVERSE_NONE
 

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

virtual osg::NodeVisitor::~NodeVisitor   [virtual]
 


Member Function Documentation

virtual void osg::NodeVisitor::apply OccluderNode   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, and osgUtil::CullVisitor.

virtual void osg::NodeVisitor::apply ClearNode   node [inline, virtual]
 

Reimplemented in osgUtil::CullVisitor.

virtual void osg::NodeVisitor::apply Impostor   node [inline, virtual]
 

Reimplemented in osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::DisplayRequirementsVisitor, and osgUtil::InsertImpostorsVisitor.

virtual void osg::NodeVisitor::apply LOD   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::InsertImpostorsVisitor, osgUtil::IntersectVisitor, and osgUtil::Optimizer::CombineLODsVisitor.

virtual void osg::NodeVisitor::apply Sequence   node [inline, virtual]
 

virtual void osg::NodeVisitor::apply Switch   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, osgUtil::CullVisitor, and osgUtil::IntersectVisitor.

virtual void osg::NodeVisitor::apply PositionAttitudeTransform   node [inline, virtual]
 

virtual void osg::NodeVisitor::apply MatrixTransform   node [inline, virtual]
 

virtual void osg::NodeVisitor::apply DOFTransform   node [inline, virtual]
 

virtual void osg::NodeVisitor::apply Transform   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::IntersectVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, and osgUtil::Optimizer::RemoveRedundentNodesVisitor.

virtual void osg::NodeVisitor::apply LightSource   node [inline, virtual]
 

Reimplemented in osgUtil::AppVisitor, and osgUtil::CullVisitor.

virtual void osg::NodeVisitor::apply ClipNode   node [inline, virtual]
 

Reimplemented in osgUtil::CullVisitor.

virtual void osg::NodeVisitor::apply Projection   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, and osgUtil::CullVisitor.

virtual void osg::NodeVisitor::apply Group   node [inline, virtual]
 

Reimplemented in osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::InsertImpostorsVisitor, osgUtil::IntersectVisitor, osgUtil::Optimizer::RemoveEmptyNodesVisitor, and osgUtil::Optimizer::RemoveRedundentNodesVisitor.

virtual void osg::NodeVisitor::apply Billboard   node [inline, virtual]
 

Reimplemented in osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::IntersectVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, and osgUtil::Optimizer::MergeGeometryVisitor.

virtual void osg::NodeVisitor::apply Geode   node [inline, virtual]
 

Reimplemented in osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::DisplayListVisitor, osgUtil::DisplayRequirementsVisitor, osgUtil::IntersectVisitor, osgUtil::Optimizer::ConvertGeoSetsToGeometryVisitor, osgUtil::Optimizer::FlattenStaticTransformsVisitor, osgUtil::Optimizer::RemoveEmptyNodesVisitor, osgUtil::Optimizer::StateVisitor, osgUtil::Optimizer::MergeGeometryVisitor, osgUtil::SmoothingVisitor, and osgUtil::TriStripVisitor.

virtual void osg::NodeVisitor::apply Node   node [inline, virtual]
 

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::DisplayListVisitor, osgUtil::DisplayRequirementsVisitor, osgUtil::InsertImpostorsVisitor, osgUtil::IntersectVisitor, osgUtil::Optimizer::ConvertGeoSetsToGeometryVisitor, and osgUtil::Optimizer::StateVisitor.

const FrameStamp* osg::NodeVisitor::getFrameStamp   const [inline]
 

Get the FrameStamp that this traversal is assoicated with.

const bool osg::NodeVisitor::getLocalToWorldMatrix Matrix   matrix,
Node   node
 

Get the Local To World Matrix from the NodePath for specified Transform::Mode, and u.

const Node::NodeMask osg::NodeVisitor::getNodeMaskOverride   const [inline]
 

Get the NodeMaskOverride mask.

const NodePath& osg::NodeVisitor::getNodePath   const [inline]
 

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

NodePath& osg::NodeVisitor::getNodePath   [inline]
 

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

const Node::NodeMask osg::NodeVisitor::getTraversalMask   const [inline]
 

Get the TraversalMask.

const TraversalMode osg::NodeVisitor::getTraversalMode   const [inline]
 

Get the traversal mode.

const int osg::NodeVisitor::getTraversalNumber   const [inline]
 

Get the traversal number.

Typically used to denote the frame count.

NodeVisitor* osg::NodeVisitor::getTraversalVisitor   [inline]
 

Get the traversal visitor, returns NULL if none is attached.

VisitorType osg::NodeVisitor::getVisitorType   const [inline]
 

Get the VisitorType.

const bool osg::NodeVisitor::getWorldToLocalMatrix Matrix   matrix,
Node   node
 

Get the World To Local Matrix from the NodePath for specified Transform::Mode.

void osg::NodeVisitor::popFromNodePath   [inline]
 

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.

void osg::NodeVisitor::pushOntoNodePath Node   node [inline]
 

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.

virtual void osg::NodeVisitor::reset   [inline, virtual]
 

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.

Reimplemented in osg::CollectOccludersVisitor, osgUtil::AppVisitor, osgUtil::CullVisitor, osgUtil::InsertImpostorsVisitor, osgUtil::IntersectVisitor, and osgUtil::Optimizer::StateVisitor.

void osg::NodeVisitor::setFrameStamp FrameStamp   fs [inline]
 

Set the FrameStamp that this traversal is assoicated with.

void osg::NodeVisitor::setNodeMaskOverride const 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 const 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 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.

void osg::NodeVisitor::setTraversalMode const 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.

void osg::NodeVisitor::setTraversalNumber const int    fn [inline]
 

Set the traversal number.

Typically used to denote the frame count.

void osg::NodeVisitor::setTraversalVisitor NodeVisitor *    nv
 

Set a visitor to handle traversal.

Overrides the traverse mode setting it to TRAVERSAL_VISITOR.

void osg::NodeVisitor::setVisitorType VisitorType    type [inline]
 

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.

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.

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


Member Data Documentation

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

Node::NodeMask osg::NodeVisitor::_nodeMaskOverride [protected]
 

NodePath osg::NodeVisitor::_nodePath [protected]
 

Reimplemented in osgUtil::IntersectVisitor.

Node::NodeMask osg::NodeVisitor::_traversalMask [protected]
 

TraversalMode osg::NodeVisitor::_traversalMode [protected]
 

int osg::NodeVisitor::_traversalNumber [protected]
 

ref_ptr<NodeVisitor> osg::NodeVisitor::_traversalVisitor [protected]
 

VisitorType osg::NodeVisitor::_visitorType [protected]
 


The documentation for this class was generated from the following file:
Generated at Wed Sep 18 13:55:34 2002 for the Open Scene Graph by doxygen 1.2.16.