osgDB::ImageOptions Class Reference

#include <ImageOptions>

Inheritance diagram for osgDB::ImageOptions:

Classes
struct	RatioWindow
	RatioWindow stores the window (as ratios of 0.0 to 1.0) from the overall imagery from which to extract the osg::Image. More...
struct	PixelWindow
	PixelWindow stores the window (in exact pixels) from the overall imagery from which to extract the osg::Image. More...
struct	TexCoordRange
	Used as UserData attached to generated osg::Image's. More...

Public Types
enum	ImageWindowMode { ALL_IMAGE , RATIO_WINDOW , PIXEL_WINDOW }
enum	ImageSamplingMode { NEAREST , LINEAR , CUBIC }
Public Types inherited from osgDB::Options
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
	ImageOptions ()
	ImageOptions (const std::string &str)
	ImageOptions (const ImageOptions &options, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osgDB, ImageOptions)
void	init ()
Public Member Functions inherited from osgDB::Options
	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.
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	setObjectCache (ObjectCache *objectCache)
	Set the ObjectCache that is used to cache previously loaded data.
ObjectCache *	getObjectCache () const
	Get the ObjectCache that is used to cache previously loaded data.
void	setPrecisionHint (PrecisionHint hint)
	Set which geometry attributes plugins should import at double precision.
PrecisionHint	getPrecisionHint () const
	Get which geometry attributes plugins should import at double precision.
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 AuthenticationMap *	getAuthenticationMap () 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.
unsigned int	getNumPluginData () const
	Get number of PluginData values.
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.
unsigned int	getNumPluginStringData () const
	Get number of PluginStrData values.
void	parsePluginStringData (const std::string &str, char separator1=' ', char separator2='=')
	Parse string into plugin string data.
void	setFindFileCallback (FindFileCallback *cb)
	Set the find callback to use in place of the default findFile calls.
FindFileCallback *	getFindFileCallback () const
	Get the const findFile callback.
void	setReadFileCallback (ReadFileCallback *cb)
	Set the read callback to use in place of the default readFile calls.
ReadFileCallback *	getReadFileCallback () const
	Get the const readFile callback.
void	setWriteFileCallback (WriteFileCallback *cb)
	Set the callback to use in place of the default writeFile calls.
WriteFileCallback *	getWriteFileCallback () const
	Get the const writeFile callback.
void	setFileLocationCallback (FileLocationCallback *cb)
	Set the callback to use inform the DatabasePager whether a file is located on local or remote file system.
FileLocationCallback *	getFileLocationCallback () const
	Get the callback to use inform the DatabasePager whether a file is located on local or remote file system.
void	setFileCache (FileCache *fileCache)
	Set the FileCache that is used to manage local storage of files downloaded from the internet.
FileCache *	getFileCache () const
	Get the FileCache that is used to manage local storage of files downloaded from the internet.
void	setTerrain (osg::observer_ptr< osg::Node > &terrain)
	Set the terrain observer_ptr, use to decorate any osgTerrain subgraphs.
const osg::observer_ptr< osg::Node > &	getTerrain () const
	Get the terrain observer_ptr, use to decorate any osgTerrain subgraphs.
void	setParentGroup (osg::observer_ptr< osg::Group > &parentGroup)
	Set the parentGroup observer_ptr, where the loaded model is intended to be added.
const osg::observer_ptr< osg::Group > &	getParentGroup () const
	Get the parentGroup observer_ptr, where the loaded model is intended to be added.
bool	operator< (const Options &rhs) const
bool	operator== (const Options &rhs) const
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object.
	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.
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type.
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library.
virtual const char *	className () const =0
	return the name of the object's class type.
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name.
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string.
void	setName (const char *name)
	Set the name of object using a C style string.
const std::string &	getName () const
	Get the name of object.
void	setDataVariance (DataVariance dv)
	Set the data variance of this object.
DataVariance	getDataVariance () const
	Get the data variance of this object.
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc.
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object.
template<class T>
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
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.
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () const
	Get const user data.
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.
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.
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
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
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref().
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object.

Public Attributes
ImageSamplingMode	_sourceImageSamplingMode
ImageWindowMode	_sourceImageWindowMode
RatioWindow	_sourceRatioWindow
PixelWindow	_sourcePixelWindow
osg::ref_ptr< osg::Image >	_destinationImage
ImageWindowMode	_destinationImageWindowMode
RatioWindow	_destinationRatioWindow
PixelWindow	_destinationPixelWindow
GLenum	_destinationDataType
GLenum	_destinationPixelFormat

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.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.
Protected Types inherited from osgDB::Options
typedef std::map< std::string, void * >	PluginDataMap
typedef std::map< std::string, std::string >	PluginStringDataMap
Protected Member Functions inherited from osgDB::Options
virtual	~Options ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor.
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const
Protected Attributes inherited from osgDB::Options
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

Member Enumeration Documentation

ImageSamplingMode

enum osgDB::ImageOptions::ImageSamplingMode

Enumerator
NEAREST
LINEAR
CUBIC

ImageWindowMode

enum osgDB::ImageOptions::ImageWindowMode

Enumerator
ALL_IMAGE
RATIO_WINDOW
PIXEL_WINDOW

Constructor & Destructor Documentation

ImageOptions() [1/3]

osgDB::ImageOptions::ImageOptions

(

)

Referenced by ImageOptions(), and META_Object().

ImageOptions() [2/3]

osgDB::ImageOptions::ImageOptions

(

const std::string &

str

)

ImageOptions() [3/3]

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

inline

References _destinationDataType, _destinationImage, _destinationImageWindowMode, _destinationPixelFormat, _destinationPixelWindow, _destinationRatioWindow, _sourceImageSamplingMode, _sourceImageWindowMode, _sourcePixelWindow, _sourceRatioWindow, ImageOptions(), osgDB::Options::Options(), and osg::CopyOp::SHALLOW_COPY.

Member Function Documentation

init()

void osgDB::ImageOptions::init

(

)

META_Object()

osgDB::ImageOptions::META_Object	(	osgDB	,
		ImageOptions	)

References ImageOptions().

Member Data Documentation

_destinationDataType

GLenum osgDB::ImageOptions::_destinationDataType

Referenced by ImageOptions().

_destinationImage

osg::ref_ptr<osg::Image> osgDB::ImageOptions::_destinationImage

Referenced by ImageOptions().

_destinationImageWindowMode

ImageWindowMode osgDB::ImageOptions::_destinationImageWindowMode

Referenced by ImageOptions().

_destinationPixelFormat

GLenum osgDB::ImageOptions::_destinationPixelFormat

Referenced by ImageOptions().

_destinationPixelWindow

PixelWindow osgDB::ImageOptions::_destinationPixelWindow

Referenced by ImageOptions().

_destinationRatioWindow

RatioWindow osgDB::ImageOptions::_destinationRatioWindow

Referenced by ImageOptions().

_sourceImageSamplingMode

ImageSamplingMode osgDB::ImageOptions::_sourceImageSamplingMode

Referenced by ImageOptions().

_sourceImageWindowMode

ImageWindowMode osgDB::ImageOptions::_sourceImageWindowMode

Referenced by ImageOptions().

_sourcePixelWindow

PixelWindow osgDB::ImageOptions::_sourcePixelWindow

Referenced by ImageOptions().

_sourceRatioWindow

RatioWindow osgDB::ImageOptions::_sourceRatioWindow

Referenced by ImageOptions().

---

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

• osgDB/ImageOptions