FGFS-4.1/OpenSceneGraph
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ran script to remove trailing spaces and tabs

Browse Source
This commit is contained in:
Robert Osfield
2012-03-21 17:36:20 +00:00
parent 1e35f8975d
commit 14a563dc9f
1495 changed files with 21873 additions and 21873 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
include/osg/NodeVisitor
View File

@@ -1,13 +1,13 @@
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
@@ -49,7 +49,7 @@ const unsigned int UNINITIALIZED_FRAME_NUMBER=0xffffffff;
virtual const char* className() const { return #name; }
/** Visitor for type safe operations on osg::Nodes.
Based on GOF's Visitor pattern. The NodeVisitor
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
@@ -61,7 +61,7 @@ const unsigned int UNINITIALIZED_FRAME_NUMBER=0xffffffff;
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. */
not be called. */
class OSG_EXPORT NodeVisitor : public virtual Referenced
{
public:
@@ -73,7 +73,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
TRAVERSE_ALL_CHILDREN,
TRAVERSE_ACTIVE_CHILDREN
};
enum VisitorType
{
NODE_VISITOR = 0,
@@ -84,11 +84,11 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
};
NodeVisitor(TraversalMode tm=TRAVERSE_NONE);
NodeVisitor(VisitorType type,TraversalMode tm=TRAVERSE_NONE);
virtual ~NodeVisitor();
/** return the library name/namespapce of the visitor's. Should be defined by derived classes.*/
virtual const char* libraryName() const { return "osg"; }
@@ -96,7 +96,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
virtual const char* className() const { return "NodeVisitor"; }
/** Method to call to reset visitor. Useful if your visitor accumulates
state during a traversal, and you plan to reuse the visitor.
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.*/
virtual void reset() {}
@@ -106,19 +106,19 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
* traversal of the scene, typically used in the Node::traverse() method
* to select which behaviour to use for different types of traversal/visitors.*/
inline void setVisitorType(VisitorType type) { _visitorType = type; }
/** Get the VisitorType.*/
inline VisitorType getVisitorType() const { return _visitorType; }
/** Set the traversal number. Typically used to denote the frame count.*/
inline void setTraversalNumber(unsigned int fn) { _traversalNumber = fn; }
/** Get the traversal number. Typically used to denote the frame count.*/
inline unsigned int getTraversalNumber() const { return _traversalNumber; }
/** Set the FrameStamp that this traversal is associated with.*/
inline void setFrameStamp(FrameStamp* fs) { _frameStamp = fs; }
/** Get the FrameStamp that this traversal is associated with.*/
inline const FrameStamp* getFrameStamp() const { return _frameStamp.get(); }
@@ -138,7 +138,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
inline Node::NodeMask getTraversalMask() const { return _traversalMask; }
/** Set the NodeMaskOverride mask.
* Used in validNodeMask() to determine whether to operate on a node or its
* 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.*/
@@ -146,7 +146,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
/** Get the NodeMaskOverride mask.*/
inline Node::NodeMask getNodeMaskOverride() const { return _nodeMaskOverride; }
/** 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
@@ -158,33 +158,33 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
return (getTraversalMask() & (getNodeMaskOverride() | node.getNodeMask()))!=0;
}
/** Set the traversal mode for Node::traverse() to use when
/** 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.*/
inline void setTraversalMode(TraversalMode mode) { _traversalMode = mode; }
/** Get the traversal mode.*/
inline TraversalMode getTraversalMode() const { return _traversalMode; }
/**
* Set user data, data must be subclassed from Referenced to allow
* automatic memory handling. If your own data isn't directly
* automatic memory handling. If your own data isn't directly
* subclassed from Referenced then create an adapter object
* which points to your own objects and handles the memory addressing.
*/
inline void setUserData(Referenced* obj) { _userData = obj; }
/** Get user data.*/
inline Referenced* getUserData() { return _userData.get(); }
/** Get const user data.*/
inline const Referenced* getUserData() const { return _userData.get(); }
/** Method for handling traversal of a nodes.
If you intend to use the visitor for actively traversing
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.*/
inline void traverse(Node& node)
@@ -192,22 +192,22 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
if (_traversalMode==TRAVERSE_PARENTS) node.ascend(*this);
else if (_traversalMode!=TRAVERSE_NONE) node.traverse(*this);
}
/** 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
* 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.*/
inline void pushOntoNodePath(Node* node) { if (_traversalMode!=TRAVERSE_PARENTS) _nodePath.push_back(node); else _nodePath.insert(_nodePath.begin(),node); }
/** 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.*/
inline void popFromNodePath() { if (_traversalMode!=TRAVERSE_PARENTS) _nodePath.pop_back(); else _nodePath.erase(_nodePath.begin()); }
/** Get the non const NodePath from the top most node applied down
* to the current Node being visited.*/
NodePath& getNodePath() { return _nodePath; }
@@ -215,7 +215,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
/** Get the const NodePath from the top most node applied down
* to the current Node being visited.*/
const NodePath& getNodePath() const { return _nodePath; }
/** Get the eye point in local coordinates.
* Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement.*/
virtual osg::Vec3 getEyePoint() const { return Vec3(0.0f,0.0f,0.0f); }
@@ -238,13 +238,13 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
* 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.*/
virtual float getDistanceToViewPoint(const Vec3& /*pos*/, bool /*useLODScale*/) const { return 0.0f; }
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);
@@ -300,23 +300,23 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
class ImageRequestHandler : public osg::Referenced
{
public:
ImageRequestHandler():
Referenced(true) {}
virtual double getPreLoadTime() const = 0;
virtual osg::Image* readImageFile(const std::string& fileName) = 0;
virtual void requestImageFile(const std::string& fileName,osg::Object* attachmentPoint, int attachmentIndex, double timeToMergeBy, const FrameStamp* framestamp) = 0;
protected:
virtual ~ImageRequestHandler() {}
};
/** Set the handler for image requests.*/
void setImageRequestHandler(ImageRequestHandler* handler) { _imageRequestHandler = handler; }
/** Get the handler for image requests.*/
ImageRequestHandler* getImageRequestHandler() { return _imageRequestHandler.get(); }
@@ -329,13 +329,13 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
VisitorType _visitorType;
unsigned int _traversalNumber;
ref_ptr<FrameStamp> _frameStamp;
TraversalMode _traversalMode;
Node::NodeMask _traversalMask;
Node::NodeMask _nodeMaskOverride;
NodePath _nodePath;
ref_ptr<Referenced> _userData;
@@ -346,7 +346,7 @@ class OSG_EXPORT NodeVisitor : public virtual Referenced
};
/** Convenience functor for assisting visiting of arrays of osg::Node's.*/
/** Convenience functor for assisting visiting of arrays of osg::Node's.*/
class NodeAcceptOp
{
public: