OpenSceneGraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgTerrain::Layer Class Reference
Inheritance diagram for osgTerrain::Layer:
Inheritance graph
[legend]

Public Member Functions

 Layer ()
 
 Layer (const Layer &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy. More...
 
 META_Object (osgTerrain, Layer)
 
void setSetName (const std::string &setname)
 Set the name of this layer. More...
 
const std::string & getSetName () const
 Get the name of this layer. More...
 
virtual void setFileName (const std::string &filename)
 Set the file name of the data associated with this layer. More...
 
virtual const std::string & getFileName () const
 Get the file name of the layer. More...
 
std::string getCompoundName () const
 Return the compound name of the layer in the form set::name::filename string. More...
 
void setLocator (Locator *locator)
 
template<class T >
void setLocator (const osg::ref_ptr< T > &locator)
 
LocatorgetLocator ()
 
const LocatorgetLocator () const
 
void setMinLevel (unsigned int minLevel)
 
unsigned int getMinLevel () const
 
void setMaxLevel (unsigned int maxLevel)
 
unsigned int getMaxLevel () const
 
void setValidDataOperator (ValidDataOperator *validDataOp)
 Set the data validation operator. More...
 
ValidDataOperatorgetValidDataOperator ()
 Get the data validation operator. More...
 
const ValidDataOperatorgetValidDataOperator () const
 Get the const data validation operator. More...
 
virtual unsigned int getNumColumns () const
 Get the number of columns. More...
 
virtual unsigned int getNumRows () const
 Get the number of rows. More...
 
void setDefaultValue (const osg::Vec4 &value)
 
const osg::Vec4getDefaultValue () const
 
void setMinFilter (osg::Texture::FilterMode filter)
 Set the minification texture filter to use when a texture is associated with this layer. More...
 
osg::Texture::FilterMode getMinFilter () const
 Get the minification texture filter to use when a texture is associated with this layer. More...
 
void setMagFilter (osg::Texture::FilterMode filter)
 Set the magnification texture filter to use when a texture is associated with this layer. More...
 
osg::Texture::FilterMode getMagFilter () const
 Get the magnification texture filter to use when a texture is associated with this layer. More...
 
virtual osg::ImagegetImage ()
 Return image associated with layer if supported. More...
 
virtual const osg::ImagegetImage () const
 Return const image associated with layer if supported. More...
 
virtual bool transform (float, float)
 
virtual bool getValue (unsigned int, unsigned int, float &) const
 Get the layer value at position i,j. More...
 
virtual bool getValue (unsigned int, unsigned int, osg::Vec2 &) const
 
virtual bool getValue (unsigned int, unsigned int, osg::Vec3 &) const
 
virtual bool getValue (unsigned int, unsigned int, osg::Vec4 &) const
 
bool getValidValue (unsigned int i, unsigned int j, float &value) const
 
bool getValidValue (unsigned int i, unsigned int j, osg::Vec2 &value) const
 
bool getValidValue (unsigned int i, unsigned int j, osg::Vec3 &value) const
 
bool getValidValue (unsigned int i, unsigned int j, osg::Vec4 &value) const
 
void computeIndices (double ndc_x, double ndc_y, unsigned int &i, unsigned int &j, double &ir, double &jr) const
 Compute column,row indices from normalized coordinates. More...
 
bool getInterpolatedValue (double ndc_x, double ndc_y, float &value) const
 Calculate the interpolated layer value at the given normalized coordinates. More...
 
bool getInterpolatedValidValue (double ndc_x, double ndc_y, float &value) const
 
virtual void dirty ()
 increment the modified count. More...
 
virtual void setModifiedCount (unsigned int)
 Set the modified count value. More...
 
virtual unsigned int getModifiedCount () const
 Get modified count value. More...
 
virtual osg::BoundingSphere computeBound (bool treatAsElevationLayer) 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...
 

Protected Member Functions

virtual ~Layer ()
 
- 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 _filename
 
osg::ref_ptr< Locator_locator
 
unsigned int _minLevel
 
unsigned int _maxLevel
 
osg::ref_ptr< ValidDataOperator_validDataOperator
 
osg::Vec4 _defaultValue
 
osg::Texture::FilterMode _minFilter
 
osg::Texture::FilterMode _magFilter
 
- 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

- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 
- 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...
 

Constructor & Destructor Documentation

◆ Layer() [1/2]

osgTerrain::Layer::Layer ( )

◆ Layer() [2/2]

osgTerrain::Layer::Layer ( const Layer ,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~Layer()

virtual osgTerrain::Layer::~Layer ( )
protectedvirtual

Member Function Documentation

◆ computeBound()

virtual osg::BoundingSphere osgTerrain::Layer::computeBound ( bool  treatAsElevationLayer) const
virtual

Reimplemented in osgTerrain::ProxyLayer.

◆ computeIndices()

void osgTerrain::Layer::computeIndices ( double  ndc_x,
double  ndc_y,
unsigned int &  i,
unsigned int &  j,
double &  ir,
double &  jr 
) const
inline

Compute column,row indices from normalized coordinates.

Parameters
[in]ndc_xNormalized X-axis coordinate.
[in]ndc_yNormalized Y-axis coordinate.
[out]iReturned X-axis (or column) index.
[out]jReturned Y-axis (or row) index.
[out]irReturned X-axis fraction.
[out]jrReturned Y-axis fraction.

◆ dirty()

virtual void osgTerrain::Layer::dirty ( )
inlinevirtual

◆ getCompoundName()

std::string osgTerrain::Layer::getCompoundName ( ) const
inline

Return the compound name of the layer in the form set::name::filename string.

References osgTerrain::createCompoundSetNameAndFileName().

◆ getDefaultValue()

const osg::Vec4& osgTerrain::Layer::getDefaultValue ( ) const
inline

◆ getFileName()

virtual const std::string& osgTerrain::Layer::getFileName ( ) const
inlinevirtual

Get the file name of the layer.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, and osgTerrain::ImageLayer.

Referenced by osgTerrain::CompositeLayer::addLayer().

◆ getImage() [1/2]

virtual osg::Image* osgTerrain::Layer::getImage ( )
inlinevirtual

Return image associated with layer if supported.

Reimplemented in osgTerrain::SwitchLayer, osgTerrain::ProxyLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

◆ getImage() [2/2]

virtual const osg::Image* osgTerrain::Layer::getImage ( ) const
inlinevirtual

Return const image associated with layer if supported.

Reimplemented in osgTerrain::SwitchLayer, osgTerrain::ProxyLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

◆ getInterpolatedValidValue()

bool osgTerrain::Layer::getInterpolatedValidValue ( double  ndc_x,
double  ndc_y,
float &  value 
) const
inline

◆ getInterpolatedValue()

bool osgTerrain::Layer::getInterpolatedValue ( double  ndc_x,
double  ndc_y,
float &  value 
) const
inline

Calculate the interpolated layer value at the given normalized coordinates.

Parameters
[in]ndc_xNormalized X-axis coordinate.
[in]ndc_yNormalized Y-axis coordinate.
[out]valueReturned layer value.
Returns
true if value is valid, else false

◆ getLocator() [1/2]

Locator* osgTerrain::Layer::getLocator ( )
inline

◆ getLocator() [2/2]

const Locator* osgTerrain::Layer::getLocator ( ) const
inline

◆ getMagFilter()

osg::Texture::FilterMode osgTerrain::Layer::getMagFilter ( ) const
inline

Get the magnification texture filter to use when a texture is associated with this layer.

◆ getMaxLevel()

unsigned int osgTerrain::Layer::getMaxLevel ( ) const
inline

◆ getMinFilter()

osg::Texture::FilterMode osgTerrain::Layer::getMinFilter ( ) const
inline

Get the minification texture filter to use when a texture is associated with this layer.

◆ getMinLevel()

unsigned int osgTerrain::Layer::getMinLevel ( ) const
inline

◆ getModifiedCount()

virtual unsigned int osgTerrain::Layer::getModifiedCount ( ) const
inlinevirtual

◆ getNumColumns()

virtual unsigned int osgTerrain::Layer::getNumColumns ( ) const
inlinevirtual

◆ getNumRows()

virtual unsigned int osgTerrain::Layer::getNumRows ( ) const
inlinevirtual

◆ getSetName()

const std::string& osgTerrain::Layer::getSetName ( ) const
inline

Get the name of this layer.

◆ getValidDataOperator() [1/2]

ValidDataOperator* osgTerrain::Layer::getValidDataOperator ( )
inline

Get the data validation operator.

◆ getValidDataOperator() [2/2]

const ValidDataOperator* osgTerrain::Layer::getValidDataOperator ( ) const
inline

Get the const data validation operator.

◆ getValidValue() [1/4]

bool osgTerrain::Layer::getValidValue ( unsigned int  i,
unsigned int  j,
float &  value 
) const
inline

◆ getValidValue() [2/4]

bool osgTerrain::Layer::getValidValue ( unsigned int  i,
unsigned int  j,
osg::Vec2 value 
) const
inline

◆ getValidValue() [3/4]

bool osgTerrain::Layer::getValidValue ( unsigned int  i,
unsigned int  j,
osg::Vec3 value 
) const
inline

◆ getValidValue() [4/4]

bool osgTerrain::Layer::getValidValue ( unsigned int  i,
unsigned int  j,
osg::Vec4 value 
) const
inline

◆ getValue() [1/4]

virtual bool osgTerrain::Layer::getValue ( unsigned int  ,
unsigned int  ,
float &   
) const
inlinevirtual

Get the layer value at position i,j.

param i X-axis (or column) index. param j Y-axis (or row) index. param value Returned layer value.

Returns
true if value is valid, else false

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, osgTerrain::ContourLayer, and osgTerrain::ImageLayer.

◆ getValue() [2/4]

virtual bool osgTerrain::Layer::getValue ( unsigned int  ,
unsigned int  ,
osg::Vec2  
) const
inlinevirtual

◆ getValue() [3/4]

virtual bool osgTerrain::Layer::getValue ( unsigned int  ,
unsigned int  ,
osg::Vec3  
) const
inlinevirtual

◆ getValue() [4/4]

virtual bool osgTerrain::Layer::getValue ( unsigned int  ,
unsigned int  ,
osg::Vec4  
) const
inlinevirtual

◆ META_Object()

osgTerrain::Layer::META_Object ( osgTerrain  ,
Layer   
)

◆ setDefaultValue()

void osgTerrain::Layer::setDefaultValue ( const osg::Vec4 value)
inline

◆ setFileName()

virtual void osgTerrain::Layer::setFileName ( const std::string &  filename)
inlinevirtual

Set the file name of the data associated with this layer.

Reimplemented in osgTerrain::ProxyLayer, osgTerrain::HeightFieldLayer, and osgTerrain::ImageLayer.

◆ setLocator() [1/2]

void osgTerrain::Layer::setLocator ( Locator locator)
inline

◆ setLocator() [2/2]

template<class T >
void osgTerrain::Layer::setLocator ( const osg::ref_ptr< T > &  locator)
inline

References osg::ref_ptr< T >::get(), and setLocator().

Referenced by setLocator().

◆ setMagFilter()

void osgTerrain::Layer::setMagFilter ( osg::Texture::FilterMode  filter)
inline

Set the magnification texture filter to use when a texture is associated with this layer.

◆ setMaxLevel()

void osgTerrain::Layer::setMaxLevel ( unsigned int  maxLevel)
inline

◆ setMinFilter()

void osgTerrain::Layer::setMinFilter ( osg::Texture::FilterMode  filter)
inline

Set the minification texture filter to use when a texture is associated with this layer.

◆ setMinLevel()

void osgTerrain::Layer::setMinLevel ( unsigned int  minLevel)
inline

◆ setModifiedCount()

virtual void osgTerrain::Layer::setModifiedCount ( unsigned int  )
inlinevirtual

◆ setSetName()

void osgTerrain::Layer::setSetName ( const std::string &  setname)
inline

Set the name of this layer.

◆ setValidDataOperator()

void osgTerrain::Layer::setValidDataOperator ( ValidDataOperator validDataOp)
inline

Set the data validation operator.

◆ transform()

virtual bool osgTerrain::Layer::transform ( float  ,
float   
)
inlinevirtual

Member Data Documentation

◆ _defaultValue

osg::Vec4 osgTerrain::Layer::_defaultValue
protected

◆ _filename

std::string osgTerrain::Layer::_filename
protected

◆ _locator

osg::ref_ptr<Locator> osgTerrain::Layer::_locator
protected

◆ _magFilter

osg::Texture::FilterMode osgTerrain::Layer::_magFilter
protected

◆ _maxLevel

unsigned int osgTerrain::Layer::_maxLevel
protected

◆ _minFilter

osg::Texture::FilterMode osgTerrain::Layer::_minFilter
protected

◆ _minLevel

unsigned int osgTerrain::Layer::_minLevel
protected

◆ _validDataOperator

osg::ref_ptr<ValidDataOperator> osgTerrain::Layer::_validDataOperator
protected

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