ExternalFileWriter.h

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_PLUGIN_IMAGE_WRITER
#define OSGDB_PLUGIN_IMAGE_WRITER 1

#include <osgDB/Export>
#include <string>
#include <map>

namespace osg
{
    class Object;
}

namespace osgDB
{

    class Options;

    class OSGDB_EXPORT ExternalFileWriter
    {
    public:
        ExternalFileWriter(const std::string & srcDirectory, const std::string & destDirectory, bool keepRelativePaths, unsigned int allowUpDirs=0);

        ExternalFileWriter(const std::string & destDirectory);

        bool write(const osg::Object & obj, const osgDB::Options * options, std::string * out_absolutePath=NULL, std::string * out_relativePath=NULL);

        struct ObjectData
        {
            ObjectData() : written(false) {}
            ObjectData(const std::string & absolutePath, const std::string & relativePath, bool written) : absolutePath(absolutePath), relativePath(relativePath), written(written) {}
            std::string absolutePath;
            std::string relativePath;
            bool written;        
        };

        typedef std::map<const osg::Object*, ObjectData> ObjectsSet;

        const ObjectsSet & getObjects() const { return _objects; }

    protected:
        // Dev note:
        // A multi-indexed structure would be more efficient for ObjectsSet (such as boost::multi_index, indexed on object pointer (unique), and hashed indexed on absolute path (unique)).
        // In order to get a correct search time, SearchMap "replaces" the multi-index structure for hashed indexes on absolute paths.
        typedef std::multimap<unsigned int, const osg::Object*> SearchMap;
        typedef unsigned int ObjectIndex;       
        ObjectsSet _objects;
        SearchMap _searchMap;                    
        ObjectIndex _lastGeneratedObjectIndex;
        const std::string _srcDirectory;
        const std::string _destDirectory;
        bool _keepRelativePaths;
        const unsigned int _allowUpDirs;

        void generateObjectName(std::string & out_relativePath, std::string & out_absolutePath, int type);

        bool absoluteObjectPathExists(const std::string & path);

    private:
        // Prevent copy
        ExternalFileWriter & operator=(const ExternalFileWriter &);
        ExternalFileWriter(const ExternalFileWriter &);
    };
}

#endif    // OSGDB_PLUGIN_IMAGE_WRITER