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:
Bit mask for which geometry attributes should be imported with double precision where source data is held in double precision This is useful for data that will be pre-processed before rendering. In general the geometry should be converted to floating point before rendering to ensure good performance.
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
| Options* osgDB::Options::cloneOptions | ( | const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY | ) | const [inline] |
References osg::clone().
| const AuthenticationMap* osgDB::Options::getAuthenticationMap | ( | ) | const [inline] |
Get the password map to be used by plugins when access files from secure locations.
| BuildKdTreesHint osgDB::Options::getBuildKdTreesHint | ( | ) | const [inline] |
Get whether the KdTrees should be built for geometry in the loader model.
Referenced by osgDB::Registry::_buildKdTreeIfRequired().
| 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.
| FileCache* osgDB::Options::getFileCache | ( | ) | const [inline] |
Get the FileCache that is used to manage local storage of files downloaded from the internet.
| 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.
| FindFileCallback* osgDB::Options::getFindFileCallback | ( | ) | const [inline] |
Get the const findFile callback.
Referenced by osgDB::Registry::findDataFile(), and osgDB::Registry::findLibraryFile().
| unsigned int osgDB::Options::getNumPluginData | ( | ) | const [inline] |
Get number of PluginData values
| unsigned int osgDB::Options::getNumPluginStringData | ( | ) | const [inline] |
Get number of PluginStrData values
| CacheHintOptions osgDB::Options::getObjectCacheHint | ( | ) | const [inline] |
Get whether the Registry::ObjectCache should be used by default.
| const std::string& osgDB::Options::getOptionString | ( | ) | const [inline] |
Get the general Options 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
| 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
| PrecisionHint osgDB::Options::getPrecisionHint | ( | ) | const [inline] |
Get which geometry attributes plugins should import at double precision.
| ReadFileCallback* osgDB::Options::getReadFileCallback | ( | ) | const [inline] |
Get the const readFile callback.
Referenced by osgDB::Registry::openArchive(), osgDB::Registry::readHeightField(), osgDB::Registry::readImage(), osgDB::Registry::readNode(), osgDB::Registry::readObject(), and osgDB::Registry::readShader().
| const osg::observer_ptr<osg::Node>& osgDB::Options::getTerrain | ( | ) | const [inline] |
Get the terrain observer_ptr, use to decorate any osgTerrain subgraphs.
| WriteFileCallback* osgDB::Options::getWriteFileCallback | ( | ) | const [inline] |
Get the const writeFile callback.
Referenced by osgDB::Registry::writeHeightField(), osgDB::Registry::writeImage(), osgDB::Registry::writeNode(), osgDB::Registry::writeObject(), and osgDB::Registry::writeShader().
| osgDB::Options::META_Object | ( | osgDB | , |
| Options | |||
| ) |
| void osgDB::Options::parsePluginStringData | ( | const std::string & | str, |
| char | separator1 = ' ', |
||
| char | separator2 = '=' |
||
| ) |
Parse string into plugin string data. This will be automatically done in Options(const std::string&)
| void osgDB::Options::removePluginData | ( | const std::string & | s | ) | const [inline] |
Remove a value from the PluginData
| void osgDB::Options::removePluginStringData | ( | const std::string & | s | ) | const [inline] |
Remove a value from the PluginData
| void osgDB::Options::setAuthenticationMap | ( | AuthenticationMap * | authenticationMap | ) | [inline] |
Set the password map to be used by plugins when access files from secure locations.
| void osgDB::Options::setBuildKdTreesHint | ( | BuildKdTreesHint | hint | ) | [inline] |
Set whether the KdTrees should be built for geometry in the loader model.
| void osgDB::Options::setDatabasePath | ( | const std::string & | str | ) | [inline] |
Set the database path to use a hint of where to look when loading models.
| void osgDB::Options::setFileCache | ( | FileCache * | fileCache | ) | [inline] |
Set the FileCache that is used to manage local storage of files downloaded from the internet.
| 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.
| void osgDB::Options::setFindFileCallback | ( | FindFileCallback * | cb | ) | [inline] |
Set the find callback to use in place of the default findFile calls.
| void osgDB::Options::setObjectCacheHint | ( | CacheHintOptions | useObjectCache | ) | [inline] |
Set whether the Registry::ObjectCache should be used by default.
| void osgDB::Options::setOptionString | ( | const std::string & | str | ) | [inline] |
Set the general Options string.
| void osgDB::Options::setPluginData | ( | const std::string & | s, |
| void * | v | ||
| ) | const [inline] |
Sets a plugindata value PluginData with a string
| void osgDB::Options::setPluginStringData | ( | const std::string & | s, |
| const std::string & | v | ||
| ) | const [inline] |
Sets a plugindata value PluginData with a string
| void osgDB::Options::setPrecisionHint | ( | PrecisionHint | hint | ) | [inline] |
Set which geometry attributes plugins should import at double precision.
| void osgDB::Options::setReadFileCallback | ( | ReadFileCallback * | cb | ) | [inline] |
Set the read callback to use in place of the default readFile calls.
| void osgDB::Options::setTerrain | ( | osg::observer_ptr< osg::Node > & | terrain | ) | [inline] |
Set the terrain observer_ptr, use to decorate any osgTerrain subgraphs.
| void osgDB::Options::setWriteFileCallback | ( | WriteFileCallback * | cb | ) | [inline] |
Set the callback to use in place of the default writeFile calls.
Member Data Documentation
BuildKdTreesHint osgDB::Options::_buildKdTreesHint [protected] |
FilePathList osgDB::Options::_databasePaths [protected] |
osg::ref_ptr<FileCache> osgDB::Options::_fileCache [protected] |
CacheHintOptions osgDB::Options::_objectCacheHint [protected] |
PluginDataMap osgDB::Options::_pluginData [mutable, protected] |
PluginStringDataMap osgDB::Options::_pluginStringData [mutable, protected] |
PrecisionHint osgDB::Options::_precisionHint [protected] |
std::string osgDB::Options::_str [protected] |
osg::observer_ptr<osg::Node> osgDB::Options::_terrain [protected] |
The documentation for this class was generated from the following file:
