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:

[legend]

List of all members.

Public Types
enum	CacheHintOptions {   CACHE_NONE = 0, CACHE_NODES = 1, CACHE_IMAGES = 2, CACHE_HEIGHTFIELDS = 4,   CACHE_ARCHIVES = 8, CACHE_OBJECTS = 16, CACHE_ALL }
	bit mask for setting up which object types get cached by readObject/Image/HeightField/Node(filename) calls 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.
FilePathList &	getDatabasePathList ()
	Get the database path which is used a hint of where to look when loading models.
const FilePathList &	getDatabasePathList () 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	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.
Protected Types
typedef std::map < std::string, void * >	PluginDataMap
Protected Member Functions
virtual	~Options ()
Protected Attributes
std::string	_str
FilePathList	_databasePaths
CacheHintOptions	_objectCacheHint
PluginDataMap	_pluginData

---

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]

---

Member Enumeration Documentation

enum osgDB::ReaderWriter::Options::CacheHintOptions

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_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

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

void osgDB::ReaderWriter::Options::setOptionString

(

const std::string &

str

)

[inline]

Set the general Options string.

const std::string& osgDB::ReaderWriter::Options::getOptionString

(

)

const [inline]

Get the general Options string.

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.

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.

void osgDB::ReaderWriter::Options::setObjectCacheHint

(

CacheHintOptions

useObjectCache

)

[inline]

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

CacheHintOptions osgDB::ReaderWriter::Options::getObjectCacheHint

(

)

const [inline]

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

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

void osgDB::ReaderWriter::Options::removePluginData

(

const std::string &

s

)

const [inline]

Remove a value from the PluginData.

---

Member Data Documentation

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

FilePathList osgDB::ReaderWriter::Options::_databasePaths [protected]

CacheHintOptions osgDB::ReaderWriter::Options::_objectCacheHint [protected]

PluginDataMap osgDB::ReaderWriter::Options::_pluginData [mutable, protected]

---

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

• osgDB/ReaderWriter

---