Added beginnings of Programming Guide, and NodeTrackerCallback.

VisualStudio/osg/osg.dsp

@@ -348,6 +348,10 @@ SOURCE=..\..\src\osg\NodeCallback.cpp
 # End Source File
 # Begin Source File
 
+SOURCE=..\..\src\osg\NodeTrackerCallback.cpp
+# End Source File
+# Begin Source File
+
 SOURCE=..\..\src\osg\NodeVisitor.cpp
 # End Source File
 # Begin Source File
@@ -832,6 +836,10 @@ SOURCE=..\..\include\osg\NodeCallback
 # End Source File
 # Begin Source File
 
+SOURCE=..\..\include\osg\NodeTrackerCallback
+# End Source File
+# Begin Source File
+
 SOURCE=..\..\Include\Osg\NodeVisitor
 # End Source File
 # Begin Source File

include/osg/NodeTrackerCallback

@@ -0,0 +1,56 @@
+/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2005 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 
+ * (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 
+ * OpenSceneGraph Public License for more details.
+*/
+
+#ifndef OSG_NODETRACKERCALLBACK
+#define OSG_NODETRACKERCALLBACK 1
+
+#include <osg/Node>
+#include <osg/NodeCallback>
+#include <osg/RefNodePath>
+
+namespace osg
+{
+
+class OSG_EXPORT NodeTrackerCallback : public NodeCallback
+{
+    public:
+
+
+        void setTrackNodePath(const osg::RefNodePath& nodePath) { _trackNodePath = nodePath; }
+        void setTrackNodePath(const osg::NodePath& nodePath) { _trackNodePath = nodePath; }
+
+        osg::RefNodePath& getTrackNodePath() { return _trackNodePath; }
+        const osg::RefNodePath& getTrackNodePath() const { return _trackNodePath; }
+
+        void setTrackNode(osg::Node* node);
+        osg::Node* getTrackNode() { return _trackNodePath.empty() ? 0 : _trackNodePath.back().get(); }
+        const osg::Node* getTrackNode() const { return _trackNodePath.empty() ? 0 : _trackNodePath.back().get(); }
+
+
+        /** Implements the callback. */
+        virtual void operator()(Node* node, NodeVisitor* nv);
+
+        /** update the node to track the nodepath.*/
+        void update(osg::Node& node);
+
+        inline bool validateNodePath() const;
+
+    protected:
+
+        osg::RefNodePath        _trackNodePath;
+
+};
+
+}
+
+#endif

src/osg/GNUmakefile

@@ -64,6 +64,7 @@ CXXFILES =\
 	MatrixTransform.cpp\
 	Multisample.cpp\
 	NodeCallback.cpp\
+	NodeTrackerCallback.cpp\
 	Node.cpp\
 	NodeVisitor.cpp\
 	Notify.cpp\

src/osg/NodeTrackerCallback.cpp

@@ -0,0 +1,135 @@
+/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2005 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 
+ * (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 
+ * OpenSceneGraph Public License for more details.
+*/
+
+#include <osg/NodeTrackerCallback>
+#include <osg/NodeVisitor>
+#include <osg/MatrixTransform>
+#include <osg/PositionAttitudeTransform>
+#include <osg/CameraView>
+#include <osg/CameraNode>
+#include <osg/Notify>
+
+using namespace osg;
+
+class CollectParentPaths : public osg::NodeVisitor
+{
+public:
+    CollectParentPaths() : 
+        osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_PARENTS) {}
+        
+    virtual void apply(osg::Node& node)
+    {
+        if (node.getNumParents()==0)
+        {
+            _nodePaths.push_back(getNodePath());
+        }
+        traverse(node);
+   }
+    
+    osg::NodePath _nodePath;
+    typedef std::vector< osg::NodePath > NodePathList;
+    NodePathList _nodePaths;
+};
+
+class ApplyMatrixVisitor : public NodeVisitor
+{
+    public:
+
+        ApplyMatrixVisitor(const osg::Matrix& matrix):
+            _matrix(matrix) {}
+
+        virtual void apply(CameraNode& camera)
+        {
+            camera.setViewMatrix(_matrix);
+        }
+
+        virtual void apply(CameraView& cv)
+        {
+            Quat rotation;
+            _matrix.get(rotation);
+            
+            cv.setPosition(_matrix.getTrans());
+            cv.setAttitude(rotation);
+        }
+
+        virtual void apply(MatrixTransform& mt)
+        {
+            mt.setMatrix(_matrix);
+        }
+        
+        virtual void apply(PositionAttitudeTransform& pat)
+        {
+            Quat rotation;
+            _matrix.get(rotation);
+            
+            pat.setPosition(_matrix.getTrans());
+            pat.setAttitude(rotation);
+        }
+        
+        osg::Matrix _matrix;
+};
+
+
+void NodeTrackerCallback::setTrackNode(osg::Node* node)
+{
+    if (!node)
+    {
+        osg::notify(osg::NOTICE)<<"NodeTrackerCallback::setTrackNode(Node*):  Unable to set tracked node due to null Node*"<<std::endl;
+        return;
+    }
+
+    CollectParentPaths cpp;
+    node->accept(cpp);
+
+    if (!cpp._nodePaths.empty())
+    {
+        osg::notify(osg::INFO)<<"NodeTrackerCallback::setTrackNode(Node*): Path set"<<std::endl;
+        _trackNodePath = cpp._nodePaths[0];
+    }
+    else
+    {
+        osg::notify(osg::NOTICE)<<"NodeTrackerCallback::setTrackNode(Node*): Unable to set tracked node due to empty parental path."<<std::endl;
+    }
+}
+
+void NodeTrackerCallback::operator()(Node* node, NodeVisitor* nv)
+{
+    if (nv->getVisitorType()==NodeVisitor::UPDATE_VISITOR)
+    {
+        update(*node);
+    }
+
+    traverse(node,nv);
+}
+
+void NodeTrackerCallback::update(osg::Node& node)
+{
+    ApplyMatrixVisitor applyMatrix(computeWorldToLocal(_trackNodePath));
+    node.accept(applyMatrix);
+}
+
+bool NodeTrackerCallback::validateNodePath() const
+{
+    if (!_trackNodePath.valid())
+    {
+        if (_trackNodePath.empty())
+        {
+            osg::notify(osg::NOTICE)<<"Warning: tracked node path has been invalidated by changes in the scene graph."<<std::endl;
+            NodeTrackerCallback* non_const_this = const_cast<NodeTrackerCallback*>(this);
+            non_const_this->_trackNodePath.clear();
+        }
+        return false;
+    }
+    return true;
+}
+