OpenSceneGraph  3.0.1
Public Types | Public Member Functions
osgDB::Archive Class Reference

Base class for implementing database Archives. More...

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

List of all members.

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_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.
virtual const char * className () const
 return the name of the object's class type.
virtual bool acceptsExtension (const std::string &) const
 Return true if ReaderWriter accepts specified file extension.
virtual void close ()=0
 close the archive.
virtual std::string getArchiveFileName () const =0
 Get the file name which represents the archived file.
virtual std::string getMasterFileName () const =0
 Get the file name which represents the master file recorded in the Archive.
virtual bool fileExists (const std::string &filename) const =0
 return true if file exists in archive.
virtual FileType getFileType (const std::string &filename) const =0
 return type of file.
virtual bool getFileNames (FileNameList &fileNames) const =0
 Get the full list of file names available in the archive.
virtual DirectoryContents getDirectoryContents (const std::string &dirName) const
 return the contents of a directory.
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.
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 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 (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.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual bool isSameKindAs (const Object *) const
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Additional Inherited Members

- Static Public Member Functions inherited from osgDB::ReaderWriter
static FeatureList featureAsString (Features feature)
 Return feature as string.
- 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


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:

osg logo
Generated at Tue Oct 9 2012 08:35:03 for the OpenSceneGraph by doxygen 1.8.1.1.