osgDB::ReaderWriter Class Reference

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

Inheritance diagram for osgDB::ReaderWriter:

[legend]

List of all members.

Classes
class	Options
	Options base class used for passing options into plugins to control their operation. More...
class	ReadResult
class	WriteResult
Public Types
enum	ArchiveStatus { READ, WRITE, CREATE }
typedef std::map< std::string, std::string >	FormatDescriptionMap
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 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
Protected Member Functions
void	supportsProtocol (const std::string &fmt, const std::string &description)
void	supportsExtension (const std::string &fmt, const std::string &description)
void	supportsOption (const std::string &fmt, const std::string &description)
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::map<std::string, std::string> osgDB::ReaderWriter::FormatDescriptionMap

---

Member Enumeration Documentation

enum osgDB::ReaderWriter::ArchiveStatus

Enumerator:

READ
WRITE
CREATE

---

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.

osgDB::ReaderWriter::META_Object	(	osgDB	,
		ReaderWriter
	)

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

open an archive for reading.

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.

Referenced by osgDB::Registry::openArchive().

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

virtual ReadResult osgDB::ReaderWriter::readHeightField	(	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::readImage	(	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::readNode	(	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::readObject	(	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 ReadResult osgDB::ReaderWriter::readShader	(	const std::string &	,
		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 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 &	fmt,
		const std::string &	description
	)			[protected]

void osgDB::ReaderWriter::supportsOption	(	const std::string &	fmt,
		const std::string &	description
	)			[protected]

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

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

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::writeImage	(	const osg::Image &	,
		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::writeNode	(	const osg::Node &	,
		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::writeObject	(	const osg::Object &	,
		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::writeShader	(	const osg::Shader &	,
		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]

---

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:

• osgDB/ReaderWriter