FileCache
Go to the documentation of this file.
/* -*-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_FILECACHE
#define OSGDB_FILECACHE 1
#include <osg/Node>
#include <osgDB/ReaderWriter>
#include <osgDB/DatabaseRevisions>
#include <set>
namespace osgDB {
class OSGDB_EXPORT FileCache : public osg::Referenced
{
public:
FileCache(const std::string& path);
const std::string& getFileCachePath() const { return _fileCachePath; }
virtual bool isFileAppropriateForFileCache(const std::string& originalFileName) const;
virtual std::string createCacheFileName(const std::string& originalFileName) const;
virtual bool existsInCache(const std::string& originalFileName) const;
virtual ReaderWriter::ReadResult readImage(const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::WriteResult writeImage(const osg::Image& image, const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::ReadResult readObject(const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::WriteResult writeObject(const osg::Object& object, const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::ReadResult readHeightField(const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::WriteResult writeHeightField(const osg::HeightField& hf, const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::ReadResult readNode(const std::string& originalFileName, const osgDB::Options* options, bool buildKdTreeIfRequired=true) const;
virtual ReaderWriter::WriteResult writeNode(const osg::Node& node, const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::ReadResult readShader(const std::string& originalFileName, const osgDB::Options* options) const;
virtual ReaderWriter::WriteResult writeShader(const osg::Shader& shader, const std::string& originalFileName, const osgDB::Options* options) const;
bool loadDatabaseRevisionsForFile(const std::string& originanlFileName);
typedef std::list< osg::ref_ptr<DatabaseRevisions> > DatabaseRevisionsList;
DatabaseRevisionsList& getDatabaseRevisionsList() { return _databaseRevisionsList; }
bool isCachedFileBlackListed(const std::string& originalFileName) const;
protected:
virtual ~FileCache();
std::string _fileCachePath;
DatabaseRevisionsList _databaseRevisionsList;
FileList* readFileList(const std::string& originalFileName) const;
bool removeFileFromBlackListed(const std::string& originalFileName) const;
};
}
#endif
DatabaseRevisions
Node
ReaderWriter
osgDB::FileCache::_databaseRevisionsList
DatabaseRevisionsList _databaseRevisionsList
Definition FileCache:68
osgDB::FileCache::loadDatabaseRevisionsForFile
bool loadDatabaseRevisionsForFile(const std::string &originanlFileName)
osgDB::FileCache::writeShader
virtual ReaderWriter::WriteResult writeShader(const osg::Shader &shader, const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::createCacheFileName
virtual std::string createCacheFileName(const std::string &originalFileName) const
osgDB::FileCache::_fileCachePath
std::string _fileCachePath
Definition FileCache:66
osgDB::FileCache::~FileCache
virtual ~FileCache()
osgDB::FileCache::isCachedFileBlackListed
bool isCachedFileBlackListed(const std::string &originalFileName) const
osgDB::FileCache::readObject
virtual ReaderWriter::ReadResult readObject(const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::getFileCachePath
const std::string & getFileCachePath() const
Definition FileCache:32
osgDB::FileCache::writeNode
virtual ReaderWriter::WriteResult writeNode(const osg::Node &node, const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::getDatabaseRevisionsList
DatabaseRevisionsList & getDatabaseRevisionsList()
Definition FileCache:58
osgDB::FileCache::writeHeightField
virtual ReaderWriter::WriteResult writeHeightField(const osg::HeightField &hf, const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::readImage
virtual ReaderWriter::ReadResult readImage(const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::readFileList
FileList * readFileList(const std::string &originalFileName) const
osgDB::FileCache::writeObject
virtual ReaderWriter::WriteResult writeObject(const osg::Object &object, const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::readNode
virtual ReaderWriter::ReadResult readNode(const std::string &originalFileName, const osgDB::Options *options, bool buildKdTreeIfRequired=true) const
osgDB::FileCache::isFileAppropriateForFileCache
virtual bool isFileAppropriateForFileCache(const std::string &originalFileName) const
osgDB::FileCache::FileCache
FileCache(const std::string &path)
osgDB::FileCache::writeImage
virtual ReaderWriter::WriteResult writeImage(const osg::Image &image, const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::readShader
virtual ReaderWriter::ReadResult readShader(const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::DatabaseRevisionsList
std::list< osg::ref_ptr< DatabaseRevisions > > DatabaseRevisionsList
Definition FileCache:57
osgDB::FileCache::removeFileFromBlackListed
bool removeFileFromBlackListed(const std::string &originalFileName) const
osgDB::FileCache::readHeightField
virtual ReaderWriter::ReadResult readHeightField(const std::string &originalFileName, const osgDB::Options *options) const
osgDB::FileCache::existsInCache
virtual bool existsInCache(const std::string &originalFileName) const
osgDB::FileList
Definition DatabaseRevisions:26
osgDB::Options
Definition Options:30
osgDB::ReaderWriter::ReadResult
Definition ReaderWriter:109
osgDB::ReaderWriter::WriteResult
Definition ReaderWriter:184
osg::HeightField
Definition Shape:483
osg::Image
Definition Image:179
osg::Node
Definition Node:72
osg::Object
Definition Object:61
osg::Referenced
Definition Referenced:44
osg::Shader
Definition Shader:89
osgDB
Definition Archive:24
OSGDB_EXPORT
#define OSGDB_EXPORT
Definition osgDB/Export:39