openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
osgDB::ReaderWriter Class Reference
Inheritance diagram for osgDB::ReaderWriter:
osg::Object osg::Referenced osgDB::Archive

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 Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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
virtual const
FormatDescriptionMap
supportedExtensions () const
virtual const
FormatDescriptionMap
supportedOptions () const
virtual bool acceptsExtension (const std::string &) const
virtual Features supportedFeatures () const
virtual bool fileExists (const std::string &filename, const Options *options) const
virtual ReadResult openArchive (const std::string &, ArchiveStatus, unsigned int=4096, const Options *=NULL) const
virtual ReadResult openArchive (std::istream &, const Options *=NULL) const
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)
void supportsExtension (const std::string &ext, const std::string &description)
void supportsOption (const std::string &opt, const std::string &description)
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
virtual const char * className () const =0
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Static Public Member Functions

static FeatureList featureAsString (Features feature)

Protected Attributes

FormatDescriptionMap _supportedProtocols
FormatDescriptionMap _supportedExtensions
FormatDescriptionMap _supportedOptions
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

- Protected Member Functions inherited from osg::Object
virtual ~Object ()

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
inlinevirtual

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
inlinevirtual

Open an archive for reading.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

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
inlinevirtual

Return which list of file extensions supported by ReaderWriter.

virtual const FormatDescriptionMap& osgDB::ReaderWriter::supportedProtocols ( ) const
inlinevirtual

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
inlinevirtual

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Reimplemented in osgDB::Archive.

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

Member Data Documentation

FormatDescriptionMap osgDB::ReaderWriter::_supportedExtensions
protected
FormatDescriptionMap osgDB::ReaderWriter::_supportedOptions
protected
FormatDescriptionMap osgDB::ReaderWriter::_supportedProtocols
protected

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