#include <ReaderWriter.h>

Inheritance diagram for osgDB::ReaderWriter:

Collaboration diagram for osgDB::ReaderWriter:

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_READ_SCRIPT = 1<<10, FEATURE_WRITE_SCRIPT = 1<<11, 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 bool	acceptsProtocol (const std::string &protocol) 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 ReadResult	readScript (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 WriteResult	writeScript (const osg::Script &, 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 ReadResult	readScript (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

virtual WriteResult	writeScript (const osg::Script &, 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 Object *	cloneType () const =0

virtual Object *	clone (const CopyOp &) const =0

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0

virtual const char *	className () const =0

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () 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

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () const

void	addObserver (Observer *observer) const

void	removeObserver (Observer *observer) const

Static Public Member Functions
static FeatureList	featureAsString (Features feature)

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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 ()

Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Detailed Description

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

Definition at line 39 of file ReaderWriter.h.

Member Typedef Documentation

typedef std::list<std::string> osgDB::ReaderWriter::FeatureList

Definition at line 55 of file ReaderWriter.h.

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

Definition at line 54 of file ReaderWriter.h.

typedef osgDB::Options osgDB::ReaderWriter::Options

Definition at line 217 of file ReaderWriter.h.

Member Enumeration Documentation

enum osgDB::ReaderWriter::ArchiveStatus

Enumerator
READ
WRITE
CREATE

Definition at line 210 of file ReaderWriter.h.

enum osgDB::ReaderWriter::Features

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_READ_SCRIPT
FEATURE_WRITE_SCRIPT
FEATURE_ALL

Definition at line 72 of file ReaderWriter.h.

Constructor & Destructor Documentation

osgDB::ReaderWriter::ReaderWriter ( )

inline

Definition at line 44 of file ReaderWriter.h.

osgDB::ReaderWriter::ReaderWriter	(	const ReaderWriter &	rw,
		const osg::CopyOp &	copyop = `osg::CopyOp::SHALLOW_COPY`
	)

inline

Definition at line 47 of file ReaderWriter.h.

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.

virtual bool osgDB::ReaderWriter::acceptsProtocol ( const std::string & protocol ) const

virtual

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 appropriate 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.

Definition at line 224 of file ReaderWriter.h.

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

inlinevirtual

Open an archive for reading.

Definition at line 227 of file ReaderWriter.h.

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

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 231 of file ReaderWriter.h.

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

inlinevirtual

Definition at line 245 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readImage	(	const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 230 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readImage	(	std::istream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 244 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readNode	(	const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 232 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readNode	(	std::istream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 246 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readObject	(	const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 229 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readObject	(	std::istream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 243 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readScript	(	const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 234 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readScript	(	std::istream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 248 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readShader	(	const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 233 of file ReaderWriter.h.

virtual ReadResult osgDB::ReaderWriter::readShader	(	std::istream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 247 of file ReaderWriter.h.

virtual const FormatDescriptionMap& osgDB::ReaderWriter::supportedExtensions ( ) const

inlinevirtual

Return which list of file extensions supported by ReaderWriter.

Definition at line 61 of file ReaderWriter.h.

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.

Definition at line 64 of file ReaderWriter.h.

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

inlinevirtual

Return which protocols are supported by ReaderWriter.

Definition at line 58 of file ReaderWriter.h.

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.

Definition at line 238 of file ReaderWriter.h.

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

inlinevirtual

Definition at line 252 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeImage	(	const osg::Image &	,
		const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 237 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeImage	(	const osg::Image &	,
		std::ostream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 251 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeNode	(	const osg::Node &	,
		const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 239 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeNode	(	const osg::Node &	,
		std::ostream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 253 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeObject	(	const osg::Object &	,
		const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 236 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeObject	(	const osg::Object &	,
		std::ostream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 250 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeScript	(	const osg::Script &	,
		const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 241 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeScript	(	const osg::Script &	,
		std::ostream &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Definition at line 255 of file ReaderWriter.h.

virtual WriteResult osgDB::ReaderWriter::writeShader	(	const osg::Shader &	,
		const std::string &	,
		const Options *	= `NULL`
	)		const

inlinevirtual

Reimplemented in osgDB::Archive.

Definition at line 240 of file ReaderWriter.h.

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

inlinevirtual

Definition at line 254 of file ReaderWriter.h.

Member Data Documentation

FormatDescriptionMap osgDB::ReaderWriter::_supportedExtensions

protected

Definition at line 278 of file ReaderWriter.h.

FormatDescriptionMap osgDB::ReaderWriter::_supportedOptions

protected

Definition at line 279 of file ReaderWriter.h.

FormatDescriptionMap osgDB::ReaderWriter::_supportedProtocols

protected

Definition at line 277 of file ReaderWriter.h.

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

osg_head/include/osgDB/ReaderWriter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation