OpenSceneGraph  3.0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
osgDB::ReaderWriter Class Reference

Pure virtual base class for reading and writing of non native formats. More...

Inheritance diagram for osgDB::ReaderWriter:
Inheritance graph
[legend]

List of all members.

Classes

class  ReadResult
class  WriteResult

Public Types

enum  Features {
  FEATURE_NONE = 0, FEATURE_READ_OBJECT = 1<<0, FEATURE_READ_IMAGE = 1<<1, FEATURE_READ_HEIGHT_FIELD = 1<<2,
  FEATURE_READ_NODE = 1<<3, FEATURE_READ_SHADER = 1<<4, FEATURE_WRITE_OBJECT = 1<<5, FEATURE_WRITE_IMAGE = 1<<6,
  FEATURE_WRITE_HEIGHT_FIELD = 1<<7, FEATURE_WRITE_NODE = 1<<8, FEATURE_WRITE_SHADER = 1<<9, FEATURE_ALL
}
 Bit mask for setting up which feature types are available for read and/or write. More...
enum  ArchiveStatus { READ, WRITE, CREATE }
typedef std::map< std::string,
std::string > 
FormatDescriptionMap
typedef std::list< std::string > FeatureList
typedef osgDB::Options Options

Public Member Functions

 ReaderWriter ()
 ReaderWriter (const ReaderWriter &rw, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual ~ReaderWriter ()
 META_Object (osgDB, ReaderWriter)
virtual const
FormatDescriptionMap
supportedProtocols () const
 Return which protocols are supported by ReaderWriter.
virtual const
FormatDescriptionMap
supportedExtensions () const
 Return which list of file extensions supported by ReaderWriter.
virtual const
FormatDescriptionMap
supportedOptions () const
 Return which list of file extensions supported by ReaderWriter.
virtual bool acceptsExtension (const std::string &) const
 Return true if ReaderWriter accepts specified file extension.
virtual Features supportedFeatures () const
 Return available features.
virtual bool fileExists (const std::string &filename, const Options *options) const
 Determine if a file exists, normally the default implementation will be appropiate for local file access but with plugins like the libcurl based one it will return true if the file is accessible at the server.
virtual ReadResult openArchive (const std::string &, ArchiveStatus, unsigned int=4096, const Options *=NULL) const
 Open an archive for reading, writing, or to create an empty archive for writing to.
virtual ReadResult openArchive (std::istream &, const Options *=NULL) const
 Open an archive for reading.
virtual ReadResult readObject (const std::string &, const Options *=NULL) const
virtual ReadResult readImage (const std::string &, const Options *=NULL) const
virtual ReadResult readHeightField (const std::string &, const Options *=NULL) const
virtual ReadResult readNode (const std::string &, const Options *=NULL) const
virtual ReadResult readShader (const std::string &, const Options *=NULL) const
virtual WriteResult writeObject (const osg::Object &, const std::string &, const Options *=NULL) const
virtual WriteResult writeImage (const osg::Image &, const std::string &, const Options *=NULL) const
virtual WriteResult writeHeightField (const osg::HeightField &, const std::string &, const Options *=NULL) const
virtual WriteResult writeNode (const osg::Node &, const std::string &, const Options *=NULL) const
virtual WriteResult writeShader (const osg::Shader &, const std::string &, const Options *=NULL) const
virtual ReadResult readObject (std::istream &, const Options *=NULL) const
virtual ReadResult readImage (std::istream &, const Options *=NULL) const
virtual ReadResult readHeightField (std::istream &, const Options *=NULL) const
virtual ReadResult readNode (std::istream &, const Options *=NULL) const
virtual ReadResult readShader (std::istream &, const Options *=NULL) const
virtual WriteResult writeObject (const osg::Object &, std::ostream &, const Options *=NULL) const
virtual WriteResult writeImage (const osg::Image &, std::ostream &, const Options *=NULL) const
virtual WriteResult writeHeightField (const osg::HeightField &, std::ostream &, const Options *=NULL) const
virtual WriteResult writeNode (const osg::Node &, std::ostream &, const Options *=NULL) const
virtual WriteResult writeShader (const osg::Shader &, std::ostream &, const Options *=NULL) const
void supportsProtocol (const std::string &fmt, const std::string &description)
 Specify fmt string as a supported protocol.
void supportsExtension (const std::string &ext, const std::string &description)
 Specify ext string as a supported file extension.
void supportsOption (const std::string &opt, const std::string &description)
 Specify option string as a supported option string.

Static Public Member Functions

static FeatureList featureAsString (Features feature)
 Return feature as string.

Protected Attributes

FormatDescriptionMap _supportedProtocols
FormatDescriptionMap _supportedExtensions
FormatDescriptionMap _supportedOptions

Detailed Description

Pure virtual base class for reading and writing of non native formats.


Member Typedef Documentation

typedef std::list<std::string> osgDB::ReaderWriter::FeatureList
typedef std::map<std::string, std::string> osgDB::ReaderWriter::FormatDescriptionMap

Member Enumeration Documentation

Enumerator:
READ 
WRITE 
CREATE 

Bit mask for setting up which feature types are available for read and/or write.

Enumerator:
FEATURE_NONE 
FEATURE_READ_OBJECT 
FEATURE_READ_IMAGE 
FEATURE_READ_HEIGHT_FIELD 
FEATURE_READ_NODE 
FEATURE_READ_SHADER 
FEATURE_WRITE_OBJECT 
FEATURE_WRITE_IMAGE 
FEATURE_WRITE_HEIGHT_FIELD 
FEATURE_WRITE_NODE 
FEATURE_WRITE_SHADER 
FEATURE_ALL 

Constructor & Destructor Documentation

osgDB::ReaderWriter::ReaderWriter ( ) [inline]
osgDB::ReaderWriter::ReaderWriter ( const ReaderWriter rw,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
) [inline]
virtual osgDB::ReaderWriter::~ReaderWriter ( ) [virtual]

Member Function Documentation

virtual bool osgDB::ReaderWriter::acceptsExtension ( const std::string &  ) const [virtual]

Return true if ReaderWriter accepts specified file extension.

Reimplemented in osgDB::Archive.

static FeatureList osgDB::ReaderWriter::featureAsString ( Features  feature) [static]

Return feature as string.

virtual bool osgDB::ReaderWriter::fileExists ( const std::string &  filename,
const Options options 
) const [virtual]

Determine if a file exists, normally the default implementation will be appropiate for local file access but with plugins like the libcurl based one it will return true if the file is accessible at the server.

osgDB::ReaderWriter::META_Object ( osgDB  ,
ReaderWriter   
)
virtual ReadResult osgDB::ReaderWriter::openArchive ( const std::string &  ,
ArchiveStatus  ,
unsigned  int = 4096,
const Options = NULL 
) const [inline, virtual]

Open an archive for reading, writing, or to create an empty archive for writing to.

virtual ReadResult osgDB::ReaderWriter::openArchive ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]

Open an archive for reading.

virtual ReadResult osgDB::ReaderWriter::readHeightField ( const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual ReadResult osgDB::ReaderWriter::readHeightField ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]
virtual ReadResult osgDB::ReaderWriter::readImage ( const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual ReadResult osgDB::ReaderWriter::readImage ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]
virtual ReadResult osgDB::ReaderWriter::readNode ( const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual ReadResult osgDB::ReaderWriter::readNode ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]
virtual ReadResult osgDB::ReaderWriter::readObject ( const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual ReadResult osgDB::ReaderWriter::readObject ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]
virtual ReadResult osgDB::ReaderWriter::readShader ( const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual ReadResult osgDB::ReaderWriter::readShader ( std::istream &  ,
const Options = NULL 
) const [inline, virtual]
virtual const FormatDescriptionMap& osgDB::ReaderWriter::supportedExtensions ( ) const [inline, virtual]

Return which list of file extensions supported by ReaderWriter.

virtual Features osgDB::ReaderWriter::supportedFeatures ( ) const [virtual]

Return available features.

virtual const FormatDescriptionMap& osgDB::ReaderWriter::supportedOptions ( ) const [inline, virtual]

Return which list of file extensions supported by ReaderWriter.

virtual const FormatDescriptionMap& osgDB::ReaderWriter::supportedProtocols ( ) const [inline, virtual]

Return which protocols are supported by ReaderWriter.

void osgDB::ReaderWriter::supportsExtension ( const std::string &  ext,
const std::string &  description 
)

Specify ext string as a supported file extension.

Please note, this method should usually only be used internally by subclasses of ReaderWriter. Only in special cases will a ReaderWriter implementation be able to handle a file extension that it wasn't originally designed for. To know whether it's safe to inject a new file extension into an existing ReaderWriter you will need to review the the source code and dependencies of that ReaderWriter.

void osgDB::ReaderWriter::supportsOption ( const std::string &  opt,
const std::string &  description 
)

Specify option string as a supported option string.

Please note, this should usually only be used internally by subclasses of ReaderWriter.

void osgDB::ReaderWriter::supportsProtocol ( const std::string &  fmt,
const std::string &  description 
)

Specify fmt string as a supported protocol.

Please note, this method should usually only be used internally by subclasses of ReaderWriter, Only in special cases will a ReaderWriter implementation be able to handle a protocol format that it wasn't originally designed for. To know whether it's safe to inject a new protocol format into an existing ReaderWriter you will need to review the source code and dependencies of that ReaderWriter.

virtual WriteResult osgDB::ReaderWriter::writeHeightField ( const osg::HeightField ,
const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual WriteResult osgDB::ReaderWriter::writeHeightField ( const osg::HeightField ,
std::ostream &  ,
const Options = NULL 
) const [inline, virtual]
virtual WriteResult osgDB::ReaderWriter::writeImage ( const osg::Image ,
const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual WriteResult osgDB::ReaderWriter::writeImage ( const osg::Image ,
std::ostream &  ,
const Options = NULL 
) const [inline, virtual]
virtual WriteResult osgDB::ReaderWriter::writeNode ( const osg::Node ,
const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual WriteResult osgDB::ReaderWriter::writeNode ( const osg::Node ,
std::ostream &  ,
const Options = NULL 
) const [inline, virtual]
virtual WriteResult osgDB::ReaderWriter::writeObject ( const osg::Object ,
const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual WriteResult osgDB::ReaderWriter::writeObject ( const osg::Object ,
std::ostream &  ,
const Options = NULL 
) const [inline, virtual]
virtual WriteResult osgDB::ReaderWriter::writeShader ( const osg::Shader ,
const std::string &  ,
const Options = NULL 
) const [inline, virtual]

Reimplemented in osgDB::Archive.

virtual WriteResult osgDB::ReaderWriter::writeShader ( const osg::Shader ,
std::ostream &  ,
const Options = NULL 
) const [inline, virtual]

Member Data Documentation


The documentation for this class was generated from the following file:

osg logo
Generated at Mon Oct 3 2011 12:39:46 for the OpenSceneGraph by doxygen 1.7.5.