Changeset 10924

Timestamp:

01/07/10 13:14:47 (3 years ago)

Author:

robert

Message:

Refactored the way that osg::Image/ImageSequence manages the update callback that needs to be attached to Textures to make it possible to use the Image::update() mechansim in other subclasses from osg::Image.
To enable the automatic attachment of the required update callback to call osg::Image::update(..) subclasses from osg::Image will
need to implement the osg::Image::requestUpdateCall() and return true, and implement the osg::Image::update(NodeVisitor?*) method to recieve the update call during the update traversal.

Location:

OpenSceneGraph/trunk

Files:

• include/osg/Image (modified) (2 diffs)
• include/osg/ImageSequence (modified) (2 diffs)
• src/osg/Image.cpp (modified) (1 diff)
• src/osg/ImageSequence.cpp (modified) (1 diff)
• src/osg/Texture1D.cpp (modified) (3 diffs)
• src/osg/Texture2D.cpp (modified) (3 diffs)
• src/osg/Texture2DArray.cpp (modified) (4 diffs)
• src/osg/Texture3D.cpp (modified) (3 diffs)
• src/osg/TextureCubeMap.cpp (modified) (4 diffs)
• src/osg/TextureRectangle.cpp (modified) (3 diffs)
• src/osgWrappers/osg/Image.cpp (modified) (3 diffs)
• src/osgWrappers/osg/ImageSequence.cpp (modified) (3 diffs)

OpenSceneGraph/trunk/include/osg/Image

@@ -20 +20 @@
 #include <osg/Vec4>
 #include <osg/FrameStamp>
+#include <osg/StateAttribute>
 
 #include <string>
@@ -321 +322 @@
         /** Get the const PixelBufferObject.*/
         const PixelBufferObject* getPixelBufferObject() const { return dynamic_cast<const PixelBufferObject*>(_bufferObject.get()); }
-       
+
+        /** return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image.*/
+        virtual bool requiresUpdateCall() const { return false; }
+
+        /** update method for osg::Image subclasses that update themselves during the update traversal.*/
         virtual void update(NodeVisitor* /*nv*/) {}
+
+        /** convience update callback class that can be attached to StateAttribute (such as Textures) to ensure
+          * that the Image::update(NodeVisitor*) method is called during the update traversal.  This callback
+          * is automatically attached when Image::requiresUpdateCall() is true (it's false by default.)
+          */
+        struct OSG_EXPORT UpdateCallback : public osg::StateAttributeCallback
+        {
+            virtual void operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv);
+        };
 
         /** method for sending pointer events to images that are acting as front ends to interactive surfaces such as a vnc or browser window.  Return true if handled. */

OpenSceneGraph/trunk/include/osg/ImageSequence

@@ -17 +17 @@
 #include <OpenThreads/Mutex>
 #include <osg/ImageStream>
-#include <osg/StateAttribute>
 
 #include <list>
@@ -102 +101 @@
         Images& getImages() { return _images; }
         const Images& getImages() const { return _images; }
-        
 
+        /** ImageSequence requires a call to update(NodeVisitor*) during the update traversal so return true.*/
+        virtual bool requiresUpdateCall() const { return true; }
+
+        /** update method for osg::Image subclasses that update themselves during the update traversal.*/
         virtual void update(NodeVisitor* nv);
-
-        struct OSG_EXPORT UpdateCallback : public osg::StateAttributeCallback
-        {
-            virtual void operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv);
-        };
 
     protected:

OpenSceneGraph/trunk/src/osg/Image.cpp

@@ -63 +63 @@
 using namespace osg;
 using namespace std;
+
+void Image::UpdateCallback::operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv)
+{
+    osg::Texture* texture = attr ? attr->asTexture() : 0;
+
+    // osg::notify(osg::NOTICE)<<"ImageSequence::UpdateCallback::"<<texture<<std::endl;
+    if (texture)
+    {
+        for(unsigned int i=0; i<texture->getNumImages(); ++i)
+        {
+            texture->getImage(i)->update(nv);
+        }
+    }
+}
 
 Image::Image()

OpenSceneGraph/trunk/src/osg/ImageSequence.cpp

@@ -23 +23 @@
 using namespace osg;
 
-void ImageSequence::UpdateCallback::operator () (osg::StateAttribute* attr, osg::NodeVisitor* nv)
-{
-    osg::Texture* texture = attr ? attr->asTexture() : 0;
-    
-    // osg::notify(osg::NOTICE)<<"ImageSequence::UpdateCallback::"<<texture<<std::endl;
-    if (texture)
-    {
-        for(unsigned int i=0; i<texture->getNumImages(); ++i)
-        {
-            texture->getImage(i)->update(nv);
-        }
-    }
-}
-
 ImageSequence::ImageSequence()
 {

OpenSceneGraph/trunk/src/osg/Texture1D.cpp

@@ -13 +13 @@
 #include <osg/GLExtensions>
 #include <osg/Texture1D>
-#include <osg/ImageSequence>
 #include <osg/State>
 #include <osg/GLU>
@@ -98 +97 @@
     if (_image == image) return;
 
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
+    if (_image.valid() && _image->requiresUpdateCall())
     {
         setUpdateCallback(0);
@@ -110 +109 @@
     _modifiedCount.setAllElementsTo(0);
     
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+    if (_image.valid() && _image->requiresUpdateCall())
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osg/Texture2D.cpp

@@ -14 +14 @@
 #include <osg/GLExtensions>
 #include <osg/Texture2D>
-#include <osg/ImageSequence>
 #include <osg/State>
 #include <osg/Notify>
@@ -111 +110 @@
     if (_image == image) return;
 
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
+    if (_image.valid() && _image->requiresUpdateCall())
     {
         setUpdateCallback(0);
@@ -119 +118 @@
     _image = image;
     _modifiedCount.setAllElementsTo(0);
-    
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+
+    if (_image.valid() && _image->requiresUpdateCall())
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osg/Texture2DArray.cpp

@@ -14 +14 @@
 #include <osg/Texture2DArray>
 #include <osg/State>
-#include <osg/ImageSequence>
 #include <osg/Notify>
 
@@ -114 +113 @@
     if (_images[layer] == image) return;
 
-    unsigned numImageSequencesBefore = 0;
+    unsigned numImageRequireUpdateBefore = 0;
     for (unsigned int i=0; i<getNumImages(); ++i)
     {
-        osg::ImageSequence* is = dynamic_cast<osg::ImageSequence*>(_images[i].get());
-        if (is) ++numImageSequencesBefore;
+        if (_images[i].valid() && _images[i]->requiresUpdateCall()) ++numImageRequireUpdateBefore;
     }
 
@@ -125 +123 @@
    _modifiedCount[layer].setAllElementsTo(0);
 
-    // find out if we need to reset the update callback to handle the animation of ImageSequence
-    unsigned numImageSequencesAfter = 0;
+    // find out if we need to reset the update callback to handle the animation of image
+    unsigned numImageRequireUpdateAfter = 0;
     for (unsigned int i=0; i<getNumImages(); ++i)
     {
-        osg::ImageSequence* is = dynamic_cast<osg::ImageSequence*>(_images[i].get());
-        if (is) ++numImageSequencesAfter;
-    }
-
-    if (numImageSequencesBefore>0)
-    {
-        if (numImageSequencesAfter==0)
+        if (_images[i].valid() && _images[i]->requiresUpdateCall()) ++numImageRequireUpdateAfter;
+    }
+
+    if (numImageRequireUpdateBefore>0)
+    {
+        if (numImageRequireUpdateAfter==0)
         {
             setUpdateCallback(0);
@@ -141 +138 @@
         }
     }
-    else if (numImageSequencesAfter>0)
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+    else if (numImageRequireUpdateAfter>0)
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osg/Texture3D.cpp

@@ -14 +14 @@
 #include <osg/Texture3D>
 #include <osg/State>
-#include <osg/ImageSequence>
 #include <osg/GLU>
 #include <osg/Notify>
@@ -110 +109 @@
     if (_image == image) return;
 
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
+    if (_image.valid() && _image->requiresUpdateCall())
     {
         setUpdateCallback(0);
@@ -122 +121 @@
 
     _image = image;
-    
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+
+    if (_image.valid() && _image->requiresUpdateCall())
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osg/TextureCubeMap.cpp

@@ -16 +16 @@
 #include <osg/State>
 #include <osg/TextureCubeMap>
-#include <osg/ImageSequence>
 #include <osg/Notify>
 
@@ -132 +131 @@
     if (_images[face] == image) return;
 
-    unsigned numImageSequencesBefore = 0;
+    unsigned numImageRequireUpdateBefore = 0;
     for (unsigned int i=0; i<getNumImages(); ++i)
     {
-        osg::ImageSequence* is = dynamic_cast<osg::ImageSequence*>(_images[i].get());
-        if (is) ++numImageSequencesBefore;
+        if (_images[i].valid() && _images[i]->requiresUpdateCall()) ++numImageRequireUpdateBefore;
     }
 
@@ -143 +141 @@
 
 
-    // find out if we need to reset the update callback to handle the animation of ImageSequence
-    unsigned numImageSequencesAfter = 0;
+    // find out if we need to reset the update callback to handle the animation of image
+    unsigned numImageRequireUpdateAfter = 0;
     for (unsigned int i=0; i<getNumImages(); ++i)
     {
-        osg::ImageSequence* is = dynamic_cast<osg::ImageSequence*>(_images[i].get());
-        if (is) ++numImageSequencesAfter;
-    }
-
-    if (numImageSequencesBefore>0)
-    {
-        if (numImageSequencesAfter==0)
+        if (_images[i].valid() && _images[i]->requiresUpdateCall()) ++numImageRequireUpdateAfter;
+    }
+
+    if (numImageRequireUpdateBefore>0)
+    {
+        if (numImageRequireUpdateAfter==0)
         {
             setUpdateCallback(0);
@@ -159 +156 @@
         }
     }
-    else if (numImageSequencesAfter>0)
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+    else if (numImageRequireUpdateAfter>0)
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osg/TextureRectangle.cpp

@@ -14 +14 @@
 #include <osg/GLExtensions>
 #include <osg/TextureRectangle>
-#include <osg/ImageSequence>
 #include <osg/State>
 #include <osg/GLU>
@@ -127 +126 @@
     if (_image == image) return;
 
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
+    if (_image.valid() && _image->requiresUpdateCall())
     {
         setUpdateCallback(0);
@@ -137 +136 @@
 
     _image = image;
-    
-    if (dynamic_cast<osg::ImageSequence*>(_image.get()))
-    {
-        setUpdateCallback(new ImageSequence::UpdateCallback());
+
+    if (_image.valid() && _image->requiresUpdateCall())
+    {
+        setUpdateCallback(new Image::UpdateCallback());
         setDataVariance(osg::Object::DYNAMIC);
     }

OpenSceneGraph/trunk/src/osgWrappers/osg/Image.cpp

@@ -17 +17 @@
 #include <osg/NodeVisitor>
 #include <osg/Object>
+#include <osg/StateAttribute>
 #include <osg/Vec2>
 #include <osg/Vec3>
@@ -376 +377 @@
                   "Get the const PixelBufferObject. ",
                   "");
+        I_Method0(bool, requiresUpdateCall,
+                  Properties::VIRTUAL,
+                  __bool__requiresUpdateCall,
+                  "return whether the update(NodeVisitor* nv) should be required on each frame to enable proper working of osg::Image. ",
+                  "");
         I_Method1(void, update, IN, osg::NodeVisitor *, x,
                   Properties::VIRTUAL,
                   __void__update__NodeVisitor_P1,
-                  "",
+                  "update method for osg::Image subclasses that update themselves during the update traversal. ",
                   "");
         I_Method3(bool, sendPointerEvent, IN, int, x, IN, int, x, IN, int, x,
@@ -499 +505 @@
 END_REFLECTOR
 
+BEGIN_OBJECT_REFLECTOR(osg::Image::UpdateCallback)
+        I_DeclaringFile("osg/Image");
+        I_BaseType(osg::StateAttributeCallback);
+        I_Constructor0(____UpdateCallback,
+                       "",
+                       "");
+END_REFLECTOR
+
 STD_VECTOR_REFLECTOR(std::vector< unsigned int >)
 

OpenSceneGraph/trunk/src/osgWrappers/osg/ImageSequence.cpp

@@ -16 +16 @@
 #include <osg/NodeVisitor>
 #include <osg/Object>
-#include <osg/StateAttribute>
 
 // Must undefine IN and OUT macros defined in Windows headers
@@ -207 +206 @@
                   "",
                   "");
+        I_Method0(bool, requiresUpdateCall,
+                  Properties::VIRTUAL,
+                  __bool__requiresUpdateCall,
+                  "ImageSequence requires a call to update(NodeVisitor*) during the update traversal so return true. ",
+                  "");
         I_Method1(void, update, IN, osg::NodeVisitor *, nv,
                   Properties::VIRTUAL,
                   __void__update__NodeVisitor_P1,
-                  "",
+                  "update method for osg::Image subclasses that update themselves during the update traversal. ",
                   "");
         I_ProtectedMethod0(void, applyLoopingMode,
@@ -270 +274 @@
 END_REFLECTOR
 
-BEGIN_OBJECT_REFLECTOR(osg::ImageSequence::UpdateCallback)
-        I_DeclaringFile("osg/ImageSequence");
-        I_BaseType(osg::StateAttributeCallback);
-        I_Constructor0(____UpdateCallback,
-                       "",
-                       "");
-END_REFLECTOR
-
 BEGIN_VALUE_REFLECTOR(osg::ref_ptr< osg::Image >)
         I_DeclaringFile("osg/ref_ptr");