OpenSceneGraph
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
osgDB::ImageOptions Class Reference
Inheritance diagram for osgDB::ImageOptions:
Inheritance graph
[legend]

Classes

struct  PixelWindow
 PixelWindow stores the window (in exact pixels) from the overall imagery from which to extract the osg::Image. More...
 
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  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)
 
OptionscloneOptions (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...
 
FilePathListgetDatabasePathList ()
 Get the database path which is used a hint of where to look when loading models. More...
 
const FilePathListgetDatabasePathList () 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...
 
ObjectCachegetObjectCache () 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 AuthenticationMapgetAuthenticationMap () 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...
 
FindFileCallbackgetFindFileCallback () 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...
 
ReadFileCallbackgetReadFileCallback () const
 Get the const readFile callback. More...
 
void setWriteFileCallback (WriteFileCallback *cb)
 Set the callback to use in place of the default writeFile calls. More...
 
WriteFileCallbackgetWriteFileCallback () 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...
 
FileLocationCallbackgetFileLocationCallback () 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...
 
FileCachegetFileCache () 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...
 
bool operator< (const Options &rhs) const
 
bool operator== (const Options &rhs) const
 
- 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (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 NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () 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 UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 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 CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, 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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 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 ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () 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)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () 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...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () 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...
 

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::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- 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. More...
 
- 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

Enumerator
NEAREST 
LINEAR 
CUBIC 

◆ ImageWindowMode

Enumerator
ALL_IMAGE 
RATIO_WINDOW 
PIXEL_WINDOW 

Constructor & Destructor Documentation

◆ ImageOptions() [1/3]

osgDB::ImageOptions::ImageOptions ( )

◆ 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 META_Object.

Member Function Documentation

◆ init()

void osgDB::ImageOptions::init ( )

◆ META_Object()

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

Member Data Documentation

◆ _destinationDataType

GLenum osgDB::ImageOptions::_destinationDataType

◆ _destinationImage

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

◆ _destinationImageWindowMode

ImageWindowMode osgDB::ImageOptions::_destinationImageWindowMode

◆ _destinationPixelFormat

GLenum osgDB::ImageOptions::_destinationPixelFormat

◆ _destinationPixelWindow

PixelWindow osgDB::ImageOptions::_destinationPixelWindow

◆ _destinationRatioWindow

RatioWindow osgDB::ImageOptions::_destinationRatioWindow

◆ _sourceImageSamplingMode

ImageSamplingMode osgDB::ImageOptions::_sourceImageSamplingMode

◆ _sourceImageWindowMode

ImageWindowMode osgDB::ImageOptions::_sourceImageWindowMode

◆ _sourcePixelWindow

PixelWindow osgDB::ImageOptions::_sourcePixelWindow

◆ _sourceRatioWindow

RatioWindow osgDB::ImageOptions::_sourceRatioWindow

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