osgDB::Options Class Reference

#include <Options.h>

Inheritance diagram for osgDB::Options:

Collaboration diagram for osgDB::Options:

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	PrecisionHint {   FLOAT_PRECISION_ALL = 0, DOUBLE_PRECISION_VERTEX = 1<<0, DOUBLE_PRECISION_NORMAL = 1<<1, DOUBLE_PRECISION_COLOR = 1<<2,   DOUBLE_PRECISION_SECONDARY_COLOR = 1<<3, DOUBLE_PRECISION_FOG_COORD = 1<<4, DOUBLE_PRECISION_TEX_COORD = 1<<5, DOUBLE_PRECISION_VERTEX_ATTRIB = 1<<6,   DOUBLE_PRECISION_ALL }
enum	BuildKdTreesHint { NO_PREFERENCE, DO_NOT_BUILD_KDTREES, BUILD_KDTREES }
	range of options of whether to build kdtrees automatically on loading More...
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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)
Options *	cloneOptions (const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY) const
void	setOptionString (const std::string &str)
const std::string &	getOptionString () const
void	setDatabasePath (const std::string &str)
FilePathList &	getDatabasePathList ()
const FilePathList &	getDatabasePathList () const
void	setObjectCacheHint (CacheHintOptions useObjectCache)
CacheHintOptions	getObjectCacheHint () const
void	setObjectCache (ObjectCache *objectCache)
ObjectCache *	getObjectCache () const
void	setPrecisionHint (PrecisionHint hint)
PrecisionHint	getPrecisionHint () const
void	setBuildKdTreesHint (BuildKdTreesHint hint)
BuildKdTreesHint	getBuildKdTreesHint () const
void	setAuthenticationMap (AuthenticationMap *authenticationMap)
const AuthenticationMap *	getAuthenticationMap () 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
unsigned int	getNumPluginData () 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
unsigned int	getNumPluginStringData () const
void	parsePluginStringData (const std::string &str, char separator1=' ', char separator2='=')
void	setFindFileCallback (FindFileCallback *cb)
FindFileCallback *	getFindFileCallback () const
void	setReadFileCallback (ReadFileCallback *cb)
ReadFileCallback *	getReadFileCallback () const
void	setWriteFileCallback (WriteFileCallback *cb)
WriteFileCallback *	getWriteFileCallback () const
void	setFileLocationCallback (FileLocationCallback *cb)
FileLocationCallback *	getFileLocationCallback () const
void	setFileCache (FileCache *fileCache)
FileCache *	getFileCache () const
void	setTerrain (osg::observer_ptr< osg::Node > &terrain)
const osg::observer_ptr < osg::Node > &	getTerrain () const
void	setParentGroup (osg::observer_ptr< osg::Group > &parentGroup)
const osg::observer_ptr < osg::Group > &	getParentGroup () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual const char *	className () const =0
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

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

Protected Member Functions
virtual	~Options ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
std::string	_str
FilePathList	_databasePaths
CacheHintOptions	_objectCacheHint
osg::ref_ptr< ObjectCache >	_objectCache
PrecisionHint	_precisionHint
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
osg::observer_ptr< osg::Node >	_terrain
osg::observer_ptr< osg::Group >	_parentGroup
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

Additional Inherited Members
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Detailed Description

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

Definition at line 29 of file Options.h.

Member Typedef Documentation

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

protected

Definition at line 272 of file Options.h.

typedef std::map<std::string,std::string> osgDB::Options::PluginStringDataMap

protected

Definition at line 274 of file Options.h.

Member Enumeration Documentation

enum osgDB::Options::BuildKdTreesHint

range of options of whether to build kdtrees automatically on loading

Enumerator
NO_PREFERENCE
DO_NOT_BUILD_KDTREES
BUILD_KDTREES

Definition at line 90 of file Options.h.

enum osgDB::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_SHADERS	cache shaders loaded via readShader(filename)
CACHE_ALL	cache on all read*(filename) calls

Definition at line 34 of file Options.h.

enum osgDB::Options::PrecisionHint

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.

Enumerator
FLOAT_PRECISION_ALL
DOUBLE_PRECISION_VERTEX
DOUBLE_PRECISION_NORMAL
DOUBLE_PRECISION_COLOR
DOUBLE_PRECISION_SECONDARY_COLOR
DOUBLE_PRECISION_FOG_COORD
DOUBLE_PRECISION_TEX_COORD
DOUBLE_PRECISION_VERTEX_ATTRIB
DOUBLE_PRECISION_ALL

Definition at line 68 of file Options.h.

Constructor & Destructor Documentation

osgDB::Options::Options ( )

inline

Definition at line 98 of file Options.h.

osgDB::Options::Options ( const std::string &  str )

inline

Definition at line 104 of file Options.h.

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

virtual osgDB::Options::~Options ( )

inlineprotectedvirtual

Definition at line 260 of file Options.h.

Member Function Documentation

Options* osgDB::Options::cloneOptions ( const osg::CopyOp &  copyop = osg::CopyOp::SHALLOW_COPY ) const

inline

Definition at line 118 of file Options.h.

Here is the call graph for this function:

const AuthenticationMap* osgDB::Options::getAuthenticationMap ( ) const

inline

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

Definition at line 166 of file Options.h.

BuildKdTreesHint osgDB::Options::getBuildKdTreesHint ( ) const

inline

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

Definition at line 159 of file Options.h.

Here is the caller graph for this function:

FilePathList& osgDB::Options::getDatabasePathList ( )

inline

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

Definition at line 130 of file Options.h.

const FilePathList& osgDB::Options::getDatabasePathList ( ) const

inline

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

Definition at line 133 of file Options.h.

FileCache* osgDB::Options::getFileCache ( ) const

inline

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

Definition at line 243 of file Options.h.

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.

Definition at line 237 of file Options.h.

FindFileCallback* osgDB::Options::getFindFileCallback ( ) const

inline

Get the const findFile callback.

Definition at line 216 of file Options.h.

Here is the caller graph for this function:

unsigned int osgDB::Options::getNumPluginData ( ) const

inline

Get number of PluginData values

Definition at line 186 of file Options.h.

unsigned int osgDB::Options::getNumPluginStringData ( ) const

inline

Get number of PluginStrData values

Definition at line 206 of file Options.h.

ObjectCache* osgDB::Options::getObjectCache ( ) const

inline

Get the ObjectCache that is used to cache previously loaded data.

Definition at line 146 of file Options.h.

CacheHintOptions osgDB::Options::getObjectCacheHint ( ) const

inline

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

Definition at line 140 of file Options.h.

const std::string& osgDB::Options::getOptionString ( ) const

inline

Get the general Options string.

Definition at line 124 of file Options.h.

const osg::observer_ptr<osg::Group>& osgDB::Options::getParentGroup ( ) const

inline

Get the parentGroup observer_ptr, where the loaded model is intended to be added

Definition at line 256 of file Options.h.

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

inline

Get a value from the PluginData

Definition at line 173 of file Options.h.

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

inline

Get a value from the PluginData

Definition at line 176 of file Options.h.

std::string& osgDB::Options::getPluginStringData ( const std::string &  s )

inline

Get a string from the PluginStrData

Definition at line 193 of file Options.h.

const std::string osgDB::Options::getPluginStringData ( const std::string &  s ) const

inline

Get a value from the PluginData

Definition at line 196 of file Options.h.

PrecisionHint osgDB::Options::getPrecisionHint ( ) const

inline

Get which geometry attributes plugins should import at double precision.

Definition at line 153 of file Options.h.

ReadFileCallback* osgDB::Options::getReadFileCallback ( ) const

inline

Get the const readFile callback.

Definition at line 223 of file Options.h.

Here is the caller graph for this function:

const osg::observer_ptr<osg::Node>& osgDB::Options::getTerrain ( ) const

inline

Get the terrain observer_ptr, use to decorate any osgTerrain subgraphs.

Definition at line 250 of file Options.h.

WriteFileCallback* osgDB::Options::getWriteFileCallback ( ) const

inline

Get the const writeFile callback.

Definition at line 230 of file Options.h.

Here is the caller graph for this function:

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

Definition at line 183 of file Options.h.

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

inline

Remove a value from the PluginData

Definition at line 203 of file Options.h.

void osgDB::Options::setAuthenticationMap ( AuthenticationMap *  authenticationMap )

inline

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

Definition at line 163 of file Options.h.

void osgDB::Options::setBuildKdTreesHint ( BuildKdTreesHint  hint )

inline

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

Definition at line 156 of file Options.h.

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

inline

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

Definition at line 127 of file Options.h.

void osgDB::Options::setFileCache ( FileCache *  fileCache )

inline

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

Definition at line 240 of file Options.h.

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.

Definition at line 234 of file Options.h.

void osgDB::Options::setFindFileCallback ( FindFileCallback *  cb )

inline

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

Definition at line 213 of file Options.h.

void osgDB::Options::setObjectCache ( ObjectCache *  objectCache )

inline

Set the ObjectCache that is used to cache previously loaded data.

Definition at line 143 of file Options.h.

void osgDB::Options::setObjectCacheHint ( CacheHintOptions  useObjectCache )

inline

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

Definition at line 137 of file Options.h.

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

inline

Set the general Options string.

Definition at line 121 of file Options.h.

void osgDB::Options::setParentGroup ( osg::observer_ptr< osg::Group > &  parentGroup )

inline

Set the parentGroup observer_ptr, where the loaded model is intended to be added

Definition at line 253 of file Options.h.

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

inline

Sets a plugindata value PluginData with a string

Definition at line 170 of file Options.h.

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

inline

Sets a plugindata value PluginData with a string

Definition at line 190 of file Options.h.

void osgDB::Options::setPrecisionHint ( PrecisionHint  hint )

inline

Set which geometry attributes plugins should import at double precision.

Definition at line 150 of file Options.h.

void osgDB::Options::setReadFileCallback ( ReadFileCallback *  cb )

inline

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

Definition at line 220 of file Options.h.

void osgDB::Options::setTerrain ( osg::observer_ptr< osg::Node > &  terrain )

inline

Set the terrain observer_ptr, use to decorate any osgTerrain subgraphs.

Definition at line 247 of file Options.h.

void osgDB::Options::setWriteFileCallback ( WriteFileCallback *  cb )

inline

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

Definition at line 227 of file Options.h.

Member Data Documentation

osg::ref_ptr<AuthenticationMap> osgDB::Options::_authenticationMap

protected

Definition at line 270 of file Options.h.

BuildKdTreesHint osgDB::Options::_buildKdTreesHint

protected

Definition at line 269 of file Options.h.

FilePathList osgDB::Options::_databasePaths

protected

Definition at line 263 of file Options.h.

osg::ref_ptr<FileCache> osgDB::Options::_fileCache

protected

Definition at line 282 of file Options.h.

osg::ref_ptr<FileLocationCallback> osgDB::Options::_fileLocationCallback

protected

Definition at line 280 of file Options.h.

osg::ref_ptr<FindFileCallback> osgDB::Options::_findFileCallback

protected

Definition at line 277 of file Options.h.

osg::ref_ptr<ObjectCache> osgDB::Options::_objectCache

protected

Definition at line 266 of file Options.h.

CacheHintOptions osgDB::Options::_objectCacheHint

protected

Definition at line 265 of file Options.h.

osg::observer_ptr<osg::Group> osgDB::Options::_parentGroup

protected

Definition at line 285 of file Options.h.

PluginDataMap osgDB::Options::_pluginData

mutableprotected

Definition at line 273 of file Options.h.

PluginStringDataMap osgDB::Options::_pluginStringData

mutableprotected

Definition at line 275 of file Options.h.

PrecisionHint osgDB::Options::_precisionHint

protected

Definition at line 268 of file Options.h.

osg::ref_ptr<ReadFileCallback> osgDB::Options::_readFileCallback

protected

Definition at line 278 of file Options.h.

std::string osgDB::Options::_str

protected

Definition at line 262 of file Options.h.

osg::observer_ptr<osg::Node> osgDB::Options::_terrain

protected

Definition at line 284 of file Options.h.

osg::ref_ptr<WriteFileCallback> osgDB::Options::_writeFileCallback

protected

Definition at line 279 of file Options.h.

---

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

• osg_head/include/osgDB/Options.h