Base class for implementing database Archives. More...

Inheritance diagram for osgDB::Archive:

Public Types
typedef osgDB::DirectoryContents	FileNameList

Public Types inherited from osgDB::ReaderWriter
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
	Archive ()

virtual	~Archive ()

virtual const char *	libraryName () const
	return the name of the object's library. More...

virtual const char *	className () const
	return the name of the object's class type. More...

virtual bool	acceptsExtension (const std::string &) const
	Return true if ReaderWriter accepts specified file extension. More...

virtual void	close ()=0
	close the archive. More...

virtual std::string	getArchiveFileName () const =0
	Get the file name which represents the archived file. More...

virtual std::string	getMasterFileName () const =0
	Get the file name which represents the master file recorded in the Archive. More...

virtual bool	fileExists (const std::string &filename) const =0
	return true if file exists in archive. More...

virtual FileType	getFileType (const std::string &filename) const =0
	return type of file. More...

virtual bool	getFileNames (FileNameList &fileNames) const =0
	Get the full list of file names available in the archive. More...

virtual DirectoryContents	getDirectoryContents (const std::string &dirName) const
	return the contents of a directory. More...

virtual ReadResult	readObject (const std::string &, const Options *=NULL) const =0

virtual ReadResult	readImage (const std::string &, const Options *=NULL) const =0

virtual ReadResult	readHeightField (const std::string &, const Options *=NULL) const =0

virtual ReadResult	readNode (const std::string &, const Options *=NULL) const =0

virtual ReadResult	readShader (const std::string &, const Options *=NULL) const =0

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

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

virtual WriteResult	writeHeightField (const osg::HeightField &, const std::string &, const Options *=NULL) const =0

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

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

Public Member Functions inherited from osgDB::ReaderWriter
	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. More...

virtual const FormatDescriptionMap &	supportedExtensions () const
	Return which list of file extensions supported by ReaderWriter. More...

virtual const FormatDescriptionMap &	supportedOptions () const
	Return which list of file extensions supported by ReaderWriter. More...

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

virtual Features	supportedFeatures () const
	Return available features. More...

virtual bool	fileExists (const std::string &filename, const Options *options) const
	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. More...

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

virtual ReadResult	openArchive (std::istream &, const Options *=NULL) const
	Open an archive for reading. More...

virtual ReadResult	readScript (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)
	Specify fmt string as a supported protocol. More...

void	supportsExtension (const std::string &ext, const std::string &description)
	Specify ext string as a supported file extension. More...

void	supportsOption (const std::string &opt, const std::string &description)
	Specify option string as a supported option string. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

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

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

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Additional Inherited Members
Static Public Member Functions inherited from osgDB::ReaderWriter
static FeatureList	featureAsString (Features feature)
	Return feature as string. More...

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...

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

void	signalObserversAndDelete (bool signalDelete, bool doDelete) const

void	deleteUsingDeleteHandler () const

Protected Attributes inherited from osgDB::ReaderWriter
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

Detailed Description

Base class for implementing database Archives.

See src/osgPlugins/osga for an example of a concrete implementation.

Member Typedef Documentation

typedef osgDB::DirectoryContents osgDB::Archive::FileNameList

Constructor & Destructor Documentation

osgDB::Archive::Archive ( )

virtual osgDB::Archive::~Archive ( )

virtual

Member Function Documentation

virtual bool osgDB::Archive::acceptsExtension ( const std::string & ) const

inlinevirtual

Return true if ReaderWriter accepts specified file extension.

Reimplemented from osgDB::ReaderWriter.

virtual const char* osgDB::Archive::className ( ) const

inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

virtual void osgDB::Archive::close ( )

pure virtual

close the archive.

virtual bool osgDB::Archive::fileExists ( const std::string & filename ) const

pure virtual

return true if file exists in archive.

virtual std::string osgDB::Archive::getArchiveFileName ( ) const

pure virtual

Get the file name which represents the archived file.

virtual DirectoryContents osgDB::Archive::getDirectoryContents ( const std::string & dirName ) const

virtual

return the contents of a directory.

returns an empty array on any error.

virtual bool osgDB::Archive::getFileNames ( FileNameList & fileNames ) const

pure virtual

Get the full list of file names available in the archive.

virtual FileType osgDB::Archive::getFileType ( const std::string & filename ) const

pure virtual

return type of file.

virtual std::string osgDB::Archive::getMasterFileName ( ) const

pure virtual

Get the file name which represents the master file recorded in the Archive.

virtual const char* osgDB::Archive::libraryName ( ) const

inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

pure virtual

Reimplemented from osgDB::ReaderWriter.

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

osgDB/Archive

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation