OpenSceneGraph 2.8.3

osgDB::ReaderWriter::Options Class Reference

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

Inheritance diagram for osgDB::ReaderWriter::Options:

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)
void setOptionString (const std::string &str)
 Set the general Options string.
const std::string & getOptionString () const
 Get the general Options string.
void setDatabasePath (const std::string &str)
 Set the database path to use a hint of where to look when loading models.
FilePathListgetDatabasePathList ()
 Get the database path which is used a hint of where to look when loading models.
const FilePathListgetDatabasePathList () const
 Get the const database path which is used a hint of where to look when loading models.
void setObjectCacheHint (CacheHintOptions useObjectCache)
 Set whether the Registry::ObjectCache should be used by default.
CacheHintOptions getObjectCacheHint () const
 Get whether the Registry::ObjectCache should be used by default.
void setBuildKdTreesHint (BuildKdTreesHint hint)
 Set whether the KdTrees should be built for geometry in the loader model.
BuildKdTreesHint getBuildKdTreesHint () const
 Get whether the KdTrees should be built for geometry in the loader model.
void setAuthenticationMap (AuthenticationMap *authenticationMap)
 Set the password map to be used by plugins when access files from secure locations.
const AuthenticationMapgetAuthenticationMap () const
 Get the password map to be used by plugins when access files from secure locations.
void setPluginData (const std::string &s, void *v) const
 Sets a plugindata value PluginData with a string.
void * getPluginData (const std::string &s)
 Get a value from the PluginData.
const void * getPluginData (const std::string &s) const
 Get a value from the PluginData.
void removePluginData (const std::string &s) const
 Remove a value from the PluginData.
void setPluginStringData (const std::string &s, const std::string &v) const
 Sets a plugindata value PluginData with a string.
std::string getPluginStringData (const std::string &s)
 Get a string from the PluginStrData.
const std::string getPluginStringData (const std::string &s) const
 Get a value from the PluginData.
void removePluginStringData (const std::string &s) const
 Remove a value from the PluginData.

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

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::ReaderWriter::Options::PluginDataMap [protected]
typedef std::map<std::string,std::string> osgDB::ReaderWriter::Options::PluginStringDataMap [protected]

Member Enumeration Documentation

range of options of whether to build kdtrees automatically on loading

Enumerator:
NO_PREFERENCE 
DO_NOT_BUILD_KDTREES 
BUILD_KDTREES 

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


Constructor & Destructor Documentation

osgDB::ReaderWriter::Options::Options ( ) [inline]
osgDB::ReaderWriter::Options::Options ( const std::string &  str) [inline]
osgDB::ReaderWriter::Options::Options ( const Options options,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
) [inline]
virtual osgDB::ReaderWriter::Options::~Options ( ) [inline, protected, virtual]

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

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

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

Get the general Options string.

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

Get a value from the PluginData.

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

Get a value from the PluginData.

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

Get a string from the PluginStrData.

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

Get a value from the PluginData.

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

Remove a value from the PluginData.

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

Remove a value from the PluginData.

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

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

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

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

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

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

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

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

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

Set the general Options string.

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

Sets a plugindata value PluginData with a string.

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

Sets a plugindata value PluginData with a string.


Member Data Documentation

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

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

osg logo
Generated at Tue Mar 22 2011 13:20:25 for the OpenSceneGraph by doxygen 1.7.3.