Moved implementation of ObjectCache functionality out of Registry into a dedicated osgDB::ObjectCache class.

git-svn-id: http://svn.openscenegraph.org/osg/OpenSceneGraph/trunk@14473 16af8721-9629-0410-8352-f15c8da7e697

include/osgDB/ObjectCache

@@ -0,0 +1,78 @@
+/* -*-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
+ * (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 OSGDB_OBJECTCACHE
+#define OSGDB_OBJECTCACHE 1
+
+#include <osg/Node>
+
+#include <osgDB/ReaderWriter>
+#include <osgDB/DatabaseRevisions>
+
+#include <map>
+
+namespace osgDB {
+
+class OSGDB_EXPORT ObjectCache : public osg::Referenced
+{
+    public:
+
+        ObjectCache();
+
+        /** For each object in the cache which has an reference count greater than 1
+          * (and therefore referenced by elsewhere in the application) set the time stamp
+          * for that object in the cache to specified time.
+          * This would typically be called once per frame by applications which are doing database paging,
+          * and need to prune objects that are no longer required.
+          * The time used should be taken from the FrameStamp::getReferenceTime().*/
+        void updateTimeStampOfObjectsInCacheWithExternalReferences(double referenceTime);
+
+        /** Removed object in the cache which have a time stamp at or before the specified expiry time.
+          * This would typically be called once per frame by applications which are doing database paging,
+          * and need to prune objects that are no longer required, and called after the a called
+          * after the call to updateTimeStampOfObjectsInCacheWithExternalReferences(expirtyTime).*/
+        void removeExpiredObjectsInCache(double expiryTime);
+
+        /** Remove all objects in the cache regardless of having external references or expiry times.*/
+        void clear();
+
+        /** Add a filename,object,timestamp triple to the Registry::ObjectCache.*/
+        void addEntryToObjectCache(const std::string& filename, osg::Object* object, double timestamp = 0.0);
+
+        /** Remove Object from cache.*/
+        void removeFromObjectCache(const std::string& fileName);
+
+        /** Get an Object from the object cache*/
+        osg::Object* getFromObjectCache(const std::string& fileName);
+
+        /** Get an ref_ptr<Object> from the object cache*/
+        osg::ref_ptr<osg::Object> getRefFromObjectCache(const std::string& fileName);
+
+        /** call rleaseGLObjects on all objects attached to the object cache.*/
+        void releaseGLObjects(osg::State* state);
+
+    protected:
+
+        virtual ~ObjectCache();
+
+        typedef std::pair<osg::ref_ptr<osg::Object>, double >           ObjectTimeStampPair;
+        typedef std::map<std::string, ObjectTimeStampPair >             ObjectCacheMap;
+
+        ObjectCacheMap                          _objectCache;
+        OpenThreads::Mutex                      _objectCacheMutex;
+
+};
+
+}
+
+#endif

include/osgDB/Registry

@@ -26,6 +26,7 @@
 #include <osgDB/DotOsgWrapper>
 #include <osgDB/ObjectWrapper>
 #include <osgDB/FileCache>
+#include <osgDB/ObjectCache>
 #include <osgDB/SharedStateManager>
 #include <osgDB/ImageProcessor>
 
@@ -417,6 +418,22 @@ class OSGDB_EXPORT Registry : public osg::Referenced
         /** get the const library file path which is used when search for library (dso/dll's) files.*/
         const FilePathList& getLibraryFilePathList() const { return _libraryFilePath; }
 
+
+
+        /** Set the ObjectCache that is used to manage local storage of files downloaded from the internet.*/
+        void setObjectCache(ObjectCache* objectCache) { _objectCache = objectCache; }
+
+        /** Get the ObjectCache that is used to manage local storage of files downloaded from the internet.*/
+        ObjectCache* getObjectCache() { return _objectCache.get(); }
+
+        /** Get the const ObjectCache that is used to manage local storage of files downloaded from the internet.*/
+        const ObjectCache* getObjectCache() const { return _objectCache.get(); }
+
+        /** set hint to viewer code calling removeExpiredObjectsInCache to specify how long it should give before expiring objects in Registry cache,*/
+        void setExpiryDelay(double expiryDelay) { _expiryDelay = expiryDelay; }
+
+        double getExpiryDelay() const { return _expiryDelay; }
+
         /** For each object in the cache which has an reference count greater than 1
           * (and therefore referenced by elsewhere in the application) set the time stamp
           * for that object in the cache to specified time.
@@ -431,12 +448,6 @@ class OSGDB_EXPORT Registry : public osg::Referenced
           * after the call to updateTimeStampOfObjectsInCacheWithExternalReferences(frameStamp).*/
         void removeExpiredObjectsInCache(const osg::FrameStamp& frameStamp);
 
-        /** set hint to viewer code calling removeExpiredObjectsInCache to specify how long it should give before expiring objects in Registry cache,*/
-        void setExpiryDelay(double expiryDelay) { _expiryDelay = expiryDelay; }
-
-        double getExpiryDelay() const { return _expiryDelay; }
-
-
         /** Remove all objects in the cache regardless of having external references or expiry times.*/
         void clearObjectCache();
 
@@ -511,8 +522,6 @@ class OSGDB_EXPORT Registry : public osg::Referenced
         typedef std::vector< osg::ref_ptr<DynamicLibrary> >             DynamicLibraryList;
         typedef std::map< std::string, std::string>                     ExtensionAliasMap;
 
-        typedef std::pair<osg::ref_ptr<osg::Object>, double >           ObjectTimeStampPair;
-        typedef std::map<std::string, ObjectTimeStampPair >             ObjectCache;
         typedef std::map<std::string, osg::ref_ptr<osgDB::Archive> >    ArchiveCache;
 
         typedef std::set<std::string>                                   RegisteredProtocolsSet;
@@ -619,9 +628,9 @@ class OSGDB_EXPORT Registry : public osg::Referenced
         FilePathList                            _dataFilePath;
         FilePathList                            _libraryFilePath;
 
+        osg::ref_ptr<ObjectCache>               _objectCache;
+
         double                                  _expiryDelay;
-        ObjectCache                             _objectCache;
-        OpenThreads::Mutex                      _objectCacheMutex;
 
 
         ArchiveExtensionList                    _archiveExtList;