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

Inheritance 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 }
	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. More...

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)
	Set the general Options string. More...

const std::string &	getOptionString () const
	Get the general Options string. More...

void	setDatabasePath (const std::string &str)
	Set the database path to use a hint of where to look when loading models. More...

FilePathList &	getDatabasePathList ()
	Get the database path which is used a hint of where to look when loading models. More...

const FilePathList &	getDatabasePathList () const
	Get the const database path which is used a hint of where to look when loading models. More...

void	setObjectCacheHint (CacheHintOptions useObjectCache)
	Set whether the Registry::ObjectCache should be used by default. More...

CacheHintOptions	getObjectCacheHint () const
	Get whether the Registry::ObjectCache should be used by default. More...

void	setObjectCache (ObjectCache *objectCache)
	Set the ObjectCache that is used to cache previously loaded data. More...

ObjectCache *	getObjectCache () const
	Get the ObjectCache that is used to cache previously loaded data. More...

void	setPrecisionHint (PrecisionHint hint)
	Set which geometry attributes plugins should import at double precision. More...

PrecisionHint	getPrecisionHint () const
	Get which geometry attributes plugins should import at double precision. More...

void	setBuildKdTreesHint (BuildKdTreesHint hint)
	Set whether the KdTrees should be built for geometry in the loader model. More...

BuildKdTreesHint	getBuildKdTreesHint () const
	Get whether the KdTrees should be built for geometry in the loader model. More...

void	setAuthenticationMap (AuthenticationMap *authenticationMap)
	Set the password map to be used by plugins when access files from secure locations. More...

const AuthenticationMap *	getAuthenticationMap () const
	Get the password map to be used by plugins when access files from secure locations. More...

void	setPluginData (const std::string &s, void *v) const
	Sets a plugindata value PluginData with a string. More...

void *	getPluginData (const std::string &s)
	Get a value from the PluginData. More...

const void *	getPluginData (const std::string &s) const
	Get a value from the PluginData. More...

void	removePluginData (const std::string &s) const
	Remove a value from the PluginData. More...

unsigned int	getNumPluginData () const
	Get number of PluginData values. More...

void	setPluginStringData (const std::string &s, const std::string &v) const
	Sets a plugindata value PluginData with a string. More...

std::string &	getPluginStringData (const std::string &s)
	Get a string from the PluginStrData. More...

const std::string	getPluginStringData (const std::string &s) const
	Get a value from the PluginData. More...

void	removePluginStringData (const std::string &s) const
	Remove a value from the PluginData. More...

unsigned int	getNumPluginStringData () const
	Get number of PluginStrData values. More...

void	parsePluginStringData (const std::string &str, char separator1=' ', char separator2='=')
	Parse string into plugin string data. More...

void	setFindFileCallback (FindFileCallback *cb)
	Set the find callback to use in place of the default findFile calls. More...

FindFileCallback *	getFindFileCallback () const
	Get the const findFile callback. More...

void	setReadFileCallback (ReadFileCallback *cb)
	Set the read callback to use in place of the default readFile calls. More...

ReadFileCallback *	getReadFileCallback () const
	Get the const readFile callback. More...

void	setWriteFileCallback (WriteFileCallback *cb)
	Set the callback to use in place of the default writeFile calls. More...

WriteFileCallback *	getWriteFileCallback () const
	Get the const writeFile callback. More...

void	setFileLocationCallback (FileLocationCallback *cb)
	Set the callback to use inform the DatabasePager whether a file is located on local or remote file system. More...

FileLocationCallback *	getFileLocationCallback () const
	Get the callback to use inform the DatabasePager whether a file is located on local or remote file system. More...

void	setFileCache (FileCache *fileCache)
	Set the FileCache that is used to manage local storage of files downloaded from the internet. More...

FileCache *	getFileCache () const
	Get the FileCache that is used to manage local storage of files downloaded from the internet. More...

void	setTerrain (osg::observer_ptr< osg::Node > &terrain)
	Set the terrain observer_ptr, use to decorate any osgTerrain subgraphs. More...

const osg::observer_ptr< osg::Node > &	getTerrain () const
	Get the terrain observer_ptr, use to decorate any osgTerrain subgraphs. More...

void	setParentGroup (osg::observer_ptr< osg::Group > &parentGroup)
	Set the parentGroup observer_ptr, where the loaded model is intended to be added. More...

const osg::observer_ptr< osg::Group > &	getParentGroup () const
	Get the parentGroup observer_ptr, where the loaded model is intended to be added. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

virtual bool	isSameKindAs (const Object *) const

virtual const char *	libraryName () const =0
	return the name of the object's library. More...

virtual const char *	className () const =0
	return the name of the object's class type. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

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 ()
	Object destructor. More...

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 ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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

enum osgDB::Options::BuildKdTreesHint

range of options of whether to build kdtrees automatically on loading

Enumerator
NO_PREFERENCE
DO_NOT_BUILD_KDTREES
BUILD_KDTREES

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

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

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 ( )

inlineprotectedvirtual

Member Function Documentation

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

inline

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.

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.

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

inline

Get number of PluginData values.

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

inline

Get number of PluginStrData values.

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

inline

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

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.

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.

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.

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.

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::setObjectCache ( ObjectCache * objectCache )

inline

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

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::setParentGroup ( osg::observer_ptr< osg::Group > & parentGroup )

inline

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

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

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

protected

BuildKdTreesHint osgDB::Options::_buildKdTreesHint

protected

FilePathList osgDB::Options::_databasePaths

protected

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

protected

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

protected

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

protected

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

protected

CacheHintOptions osgDB::Options::_objectCacheHint

protected

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

protected

PluginDataMap osgDB::Options::_pluginData

mutableprotected

PluginStringDataMap osgDB::Options::_pluginStringData

mutableprotected

PrecisionHint osgDB::Options::_precisionHint

protected

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

protected

std::string osgDB::Options::_str

protected

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

protected

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

protected

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

osgDB/Options

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation