/* -*-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_WRITEFILE
#define OSGDB_WRITEFILE 1

#include <osg/Image>
#include <osg/Shape>
#include <osg/Node>

#include <osgDB/Export>
#include <osgDB/Registry>

#include <string>

namespace osgDB {

/** Write an osg::Object to file. 
  * Return true on success,
  * return false on failure.
  * Use the Options object to control cache operations and file search paths in osgDB::Registry.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
extern OSGDB_EXPORT bool writeObjectFile(const osg::Object& object, const std::string& filename, const Options* options );

/** Write an osg::Object to file. 
  * Return true on success,
  * return false on failure.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
inline bool writeObjectFile(const osg::Object& object, const std::string& filename)
{
    return writeObjectFile( object, filename, Registry::instance()->getOptions() );
}

/** Write an osg::Image to file. 
  * Return true on success,
  * return false on failure.
  * Use the Options object to control cache operations and file search paths in osgDB::Registry.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
extern OSGDB_EXPORT bool writeImageFile(const osg::Image& image, const std::string& filename, const Options* options );

/** Write an osg::Image to file. 
  * Return true on success,
  * return false on failure.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
inline bool writeImageFile(const osg::Image& image, const std::string& filename)
{
    return writeImageFile( image, filename, Registry::instance()->getOptions() );
}

/** Write an osg::HeightField to file. 
  * Return true on success,
  * return false on failure.
  * Use the Options object to control cache operations and file search paths in osgDB::Registry.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
extern OSGDB_EXPORT bool writeHeightFieldFile(const osg::HeightField& hf, const std::string& filename, const Options* options );

/** Write an osg::HeightField to file. 
  * Return true on success,
  * return false on failure.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
inline bool writeHeightFieldFile(const osg::HeightField& hf, const std::string& filename)
{
    return writeHeightFieldFile( hf, filename, Registry::instance()->getOptions() );
}

/** Write an osg::Node to file. 
  * Return true on success,
  * return false on failure.
  * Use the Options object to control cache operations and file search paths in osgDB::Registry.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
extern OSGDB_EXPORT bool writeNodeFile(const osg::Node& node, const std::string& filename, const Options* options );

/** Write an osg::Node to file. 
  * Return true on success,
  * return false on failure.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
inline bool writeNodeFile(const osg::Node& node, const std::string& filename)
{
    return writeNodeFile( node, filename, Registry::instance()->getOptions() );
}

/** Write an osg::Shader to file. 
  * Return true on success,
  * return false on failure.
  * Use the Options object to control cache operations and file search paths in osgDB::Registry.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
extern OSGDB_EXPORT bool writeShaderFile(const osg::Shader& shader, const std::string& filename, const Options* options );

/** Write an osg::Shader to file. 
  * Return true on success,
  * return false on failure.
  * The osgDB::Registry is used to load the appropriate ReaderWriter plugin
  * for the filename extension, and this plugin then handles the request
  * to write the specified file.*/
inline bool writeShaderFile(const osg::Shader& shader, const std::string& filename)
{
    return writeShaderFile( shader, filename, Registry::instance()->getOptions() );
}

}

#endif
