osgDB::Options Class Reference

Inheritance diagram for osgDB::Options:

osg::Object osg::Referenced osgDB::ImageOptions

List of all members.

Public Types

enum  CacheHintOptions {
  CACHE_NONE = 0, CACHE_NODES = 1<<0, CACHE_IMAGES = 1<<1, CACHE_HEIGHTFIELDS = 1<<2,
  CACHE_ARCHIVES = 1<<3, CACHE_OBJECTS = 1<<4, CACHE_SHADERS = 1<<5, CACHE_ALL
}
 bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls More...
enum  BuildKdTreesHint { NO_PREFERENCE, DO_NOT_BUILD_KDTREES, BUILD_KDTREES }
 range of options of whether to build kdtrees automatically on loading More...

Public Member Functions

 Options ()
 Options (const std::string &str)
 Options (const Options &options, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgDB, Options)
OptionscloneOptions () const
void setOptionString (const std::string &str)
const std::string & getOptionString () const
void setDatabasePath (const std::string &str)
FilePathListgetDatabasePathList ()
const FilePathListgetDatabasePathList () const
void setObjectCacheHint (CacheHintOptions useObjectCache)
CacheHintOptions getObjectCacheHint () const
void setBuildKdTreesHint (BuildKdTreesHint hint)
BuildKdTreesHint getBuildKdTreesHint () const
void setAuthenticationMap (AuthenticationMap *authenticationMap)
const AuthenticationMapgetAuthenticationMap () const
void setPluginData (const std::string &s, void *v) const
void * getPluginData (const std::string &s)
const void * getPluginData (const std::string &s) const
void removePluginData (const std::string &s) const
void setPluginStringData (const std::string &s, const std::string &v) const
std::string & getPluginStringData (const std::string &s)
const std::string getPluginStringData (const std::string &s) const
void removePluginStringData (const std::string &s) const
void setFindFileCallback (FindFileCallback *cb)
FindFileCallbackgetFindFileCallback () const
void setReadFileCallback (ReadFileCallback *cb)
ReadFileCallbackgetReadFileCallback () const
void setWriteFileCallback (WriteFileCallback *cb)
WriteFileCallbackgetWriteFileCallback () const
void setFileLocationCallback (FileLocationCallback *cb)
FileLocationCallbackgetFileLocationCallback () const
void setFileCache (FileCache *fileCache)
FileCachegetFileCache () const

Protected Types

typedef std::map< std::string,
void * > 
PluginDataMap
typedef std::map< std::string,
std::string > 
PluginStringDataMap

Protected Member Functions

virtual ~Options ()

Protected Attributes

std::string _str
FilePathList _databasePaths
CacheHintOptions _objectCacheHint
BuildKdTreesHint _buildKdTreesHint
osg::ref_ptr< AuthenticationMap_authenticationMap
PluginDataMap _pluginData
PluginStringDataMap _pluginStringData
osg::ref_ptr< FindFileCallback_findFileCallback
osg::ref_ptr< ReadFileCallback_readFileCallback
osg::ref_ptr< WriteFileCallback_writeFileCallback
osg::ref_ptr
< FileLocationCallback
_fileLocationCallback
osg::ref_ptr< FileCache_fileCache


Detailed Description

Options base class used for passing options into plugins to control their operation.

Member Typedef Documentation

typedef std::map<std::string,void*> osgDB::Options::PluginDataMap [protected]

typedef std::map<std::string,std::string> osgDB::Options::PluginStringDataMap [protected]


Member Enumeration Documentation

bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls

Enumerator:
CACHE_NONE  do not cache objects of any type
CACHE_NODES  cache nodes loaded via readNode(filename)
CACHE_IMAGES  cache images loaded via readImage(filename)
CACHE_HEIGHTFIELDS  cache heightfield loaded via readHeightField(filename)
CACHE_ARCHIVES  cache heightfield loaded via readHeightField(filename)
CACHE_OBJECTS  cache objects loaded via readObject(filename)
CACHE_SHADERS  cache shaders loaded via readShader(filename)
CACHE_ALL  cache on all read*(filename) calls

range of options of whether to build kdtrees automatically on loading

Enumerator:
NO_PREFERENCE 
DO_NOT_BUILD_KDTREES 
BUILD_KDTREES 


Constructor & Destructor Documentation

osgDB::Options::Options (  )  [inline]

osgDB::Options::Options ( const std::string &  str  )  [inline]

osgDB::Options::Options ( const Options options,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

virtual osgDB::Options::~Options (  )  [inline, protected, virtual]


Member Function Documentation

osgDB::Options::META_Object ( osgDB  ,
Options   
)

Options* osgDB::Options::cloneOptions (  )  const [inline]

void osgDB::Options::setOptionString ( const std::string &  str  )  [inline]

Set the general Options string.

const std::string& osgDB::Options::getOptionString (  )  const [inline]

Get the general Options string.

void osgDB::Options::setDatabasePath ( const std::string &  str  )  [inline]

Set the database path to use a hint of where to look when loading models.

FilePathList& osgDB::Options::getDatabasePathList (  )  [inline]

Get the database path which is used a hint of where to look when loading models.

const FilePathList& osgDB::Options::getDatabasePathList (  )  const [inline]

Get the const database path which is used a hint of where to look when loading models.

void osgDB::Options::setObjectCacheHint ( CacheHintOptions  useObjectCache  )  [inline]

Set whether the Registry::ObjectCache should be used by default.

CacheHintOptions osgDB::Options::getObjectCacheHint (  )  const [inline]

Get whether the Registry::ObjectCache should be used by default.

void osgDB::Options::setBuildKdTreesHint ( BuildKdTreesHint  hint  )  [inline]

Set whether the KdTrees should be built for geometry in the loader model.

BuildKdTreesHint osgDB::Options::getBuildKdTreesHint (  )  const [inline]

Get whether the KdTrees should be built for geometry in the loader model.

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

void osgDB::Options::setAuthenticationMap ( AuthenticationMap authenticationMap  )  [inline]

Set the password map to be used by plugins when access files from secure locations.

const AuthenticationMap* osgDB::Options::getAuthenticationMap (  )  const [inline]

Get the password map to be used by plugins when access files from secure locations.

void osgDB::Options::setPluginData ( const std::string &  s,
void *  v 
) const [inline]

Sets a plugindata value PluginData with a string

void* osgDB::Options::getPluginData ( const std::string &  s  )  [inline]

Get a value from the PluginData

const void* osgDB::Options::getPluginData ( const std::string &  s  )  const [inline]

Get a value from the PluginData

void osgDB::Options::removePluginData ( const std::string &  s  )  const [inline]

Remove a value from the PluginData

void osgDB::Options::setPluginStringData ( const std::string &  s,
const std::string &  v 
) const [inline]

Sets a plugindata value PluginData with a string

std::string& osgDB::Options::getPluginStringData ( const std::string &  s  )  [inline]

Get a string from the PluginStrData

const std::string osgDB::Options::getPluginStringData ( const std::string &  s  )  const [inline]

Get a value from the PluginData

void osgDB::Options::removePluginStringData ( const std::string &  s  )  const [inline]

Remove a value from the PluginData

void osgDB::Options::setFindFileCallback ( FindFileCallback cb  )  [inline]

Set the find callback to use in place of the default findFile calls.

FindFileCallback* osgDB::Options::getFindFileCallback (  )  const [inline]

Get the const findFile callback.

Referenced by osgDB::Registry::findDataFile(), and osgDB::Registry::findLibraryFile().

void osgDB::Options::setReadFileCallback ( ReadFileCallback cb  )  [inline]

Set the read callback to use in place of the default readFile calls.

ReadFileCallback* osgDB::Options::getReadFileCallback (  )  const [inline]

void osgDB::Options::setWriteFileCallback ( WriteFileCallback cb  )  [inline]

Set the callback to use in place of the default writeFile calls.

WriteFileCallback* osgDB::Options::getWriteFileCallback (  )  const [inline]

void osgDB::Options::setFileLocationCallback ( FileLocationCallback cb  )  [inline]

Set the callback to use inform the DatabasePager whether a file is located on local or remote file system.

FileLocationCallback* osgDB::Options::getFileLocationCallback (  )  const [inline]

Get the callback to use inform the DatabasePager whether a file is located on local or remote file system.

void osgDB::Options::setFileCache ( FileCache fileCache  )  [inline]

Set the FileCache that is used to manage local storage of files downloaded from the internet.

FileCache* osgDB::Options::getFileCache (  )  const [inline]

Get the FileCache that is used to manage local storage of files downloaded from the internet.


Member Data Documentation

std::string osgDB::Options::_str [protected]


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

Generated on Sat Mar 20 12:34:01 2010 for openscenegraph by  doxygen 1.5.6