OpenSceneGraph 3.6.5
osg::HeightField Class Reference

#include <Shape>

Inheritance diagram for osg::HeightField:

Public Types

typedef std::vector< float > HeightList
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Public Member Functions

 HeightField ()
 HeightField (const HeightField &mesh, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Shape (osg, HeightField)
void allocate (unsigned int numColumns, unsigned int numRows)
unsigned int getNumColumns () const
unsigned int getNumRows () const
void setOrigin (const Vec3 &origin)
const Vec3getOrigin () const
void setXInterval (float dx)
float getXInterval () const
void setYInterval (float dy)
float getYInterval () const
FloatArraygetFloatArray ()
 Get the FloatArray height data.
const FloatArraygetFloatArray () const
 Get the const FloatArray height data.
HeightListgetHeightList ()
const HeightListgetHeightList () const
void setSkirtHeight (float skirtHeight)
 Set the height of the skirt to render around the edge of HeightField.
float getSkirtHeight () const
 Get the height of the skirt to render around the edge of HeightField.
void setBorderWidth (unsigned int borderWidth)
 Set the width in number of cells in from the edge that the height field should be rendered from.
unsigned int getBorderWidth () const
 Get the width in number of cells in from the edge that the height field should be rendered from.
void setRotation (const Quat &quat)
const QuatgetRotation () const
Matrix computeRotationMatrix () const
bool zeroRotation () const
void setHeight (unsigned int c, unsigned int r, float value)
float & getHeight (unsigned int c, unsigned int r)
float getHeight (unsigned int c, unsigned int r) const
Vec3 getVertex (unsigned int c, unsigned int r) const
Vec3 getNormal (unsigned int c, unsigned int r) const
Vec2 getHeightDelta (unsigned int c, unsigned int r) const
Public Member Functions inherited from osg::Shape
 Shape ()
 Shape (const Shape &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an attribute, with Object* return type.
virtual bool isSameKindAs (const Object *obj) const
 return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 return the name of the attribute's library.
virtual const char * className () const
 return the name of the attribute's class type.
virtual void accept (ShapeVisitor &)=0
 accept a non const shape visitor which can be used on non const shape objects.
virtual void accept (ConstShapeVisitor &) const =0
 accept a const shape visitor which can be used on const shape objects.
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.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () 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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
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.
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 ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () 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 &)
Referencedoperator= (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.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () 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.

Protected Member Functions

virtual ~HeightField ()
Protected Member Functions inherited from osg::Shape
virtual ~Shape ()
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

unsigned int _columns
unsigned int _rows
Vec3 _origin
float _dx
float _dy
float _skirtHeight
unsigned int _borderWidth
Quat _rotation
ref_ptr< FloatArray_heights
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.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Member Typedef Documentation

◆ HeightList

typedef std::vector<float> osg::HeightField::HeightList

Constructor & Destructor Documentation

◆ HeightField() [1/2]

osg::HeightField::HeightField ( )

Referenced by HeightField(), and META_Shape().

◆ HeightField() [2/2]

osg::HeightField::HeightField ( const HeightField & mesh,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )

◆ ~HeightField()

virtual osg::HeightField::~HeightField ( )
protectedvirtual

Member Function Documentation

◆ allocate()

void osg::HeightField::allocate ( unsigned int numColumns,
unsigned int numRows )

◆ computeRotationMatrix()

Matrix osg::HeightField::computeRotationMatrix ( ) const
inline

References _rotation.

◆ getBorderWidth()

unsigned int osg::HeightField::getBorderWidth ( ) const
inline

Get the width in number of cells in from the edge that the height field should be rendered from.

References _borderWidth.

◆ getFloatArray() [1/2]

FloatArray * osg::HeightField::getFloatArray ( )
inline

Get the FloatArray height data.

References _heights.

◆ getFloatArray() [2/2]

const FloatArray * osg::HeightField::getFloatArray ( ) const
inline

Get the const FloatArray height data.

References _heights.

◆ getHeight() [1/2]

float & osg::HeightField::getHeight ( unsigned int c,
unsigned int r )
inline

References _columns, and _heights.

◆ getHeight() [2/2]

float osg::HeightField::getHeight ( unsigned int c,
unsigned int r ) const
inline

References _columns, and _heights.

◆ getHeightDelta()

Vec2 osg::HeightField::getHeightDelta ( unsigned int c,
unsigned int r ) const

◆ getHeightList() [1/2]

HeightList & osg::HeightField::getHeightList ( )
inline

References _heights.

◆ getHeightList() [2/2]

const HeightList & osg::HeightField::getHeightList ( ) const
inline

References _heights.

◆ getNormal()

Vec3 osg::HeightField::getNormal ( unsigned int c,
unsigned int r ) const

◆ getNumColumns()

unsigned int osg::HeightField::getNumColumns ( ) const
inline

References _columns.

◆ getNumRows()

unsigned int osg::HeightField::getNumRows ( ) const
inline

References _rows.

◆ getOrigin()

const Vec3 & osg::HeightField::getOrigin ( ) const
inline

References _origin.

◆ getRotation()

const Quat & osg::HeightField::getRotation ( ) const
inline

References _rotation.

◆ getSkirtHeight()

float osg::HeightField::getSkirtHeight ( ) const
inline

Get the height of the skirt to render around the edge of HeightField.

References _skirtHeight.

◆ getVertex()

Vec3 osg::HeightField::getVertex ( unsigned int c,
unsigned int r ) const
inline

◆ getXInterval()

float osg::HeightField::getXInterval ( ) const
inline

References _dx.

Referenced by getVertex().

◆ getYInterval()

float osg::HeightField::getYInterval ( ) const
inline

References _dy.

Referenced by getVertex().

◆ META_Shape()

osg::HeightField::META_Shape ( osg ,
HeightField  )

References HeightField().

◆ setBorderWidth()

void osg::HeightField::setBorderWidth ( unsigned int borderWidth)
inline

Set the width in number of cells in from the edge that the height field should be rendered from.

This exists to allow gradient and curvature continutity to be maintained between adjacent HeightField, where the border cells will overlap adjacent HeightField.

References _borderWidth.

◆ setHeight()

void osg::HeightField::setHeight ( unsigned int c,
unsigned int r,
float value )
inline

References _columns.

◆ setOrigin()

void osg::HeightField::setOrigin ( const Vec3 & origin)
inline

References _origin.

◆ setRotation()

void osg::HeightField::setRotation ( const Quat & quat)
inline

References _rotation.

◆ setSkirtHeight()

void osg::HeightField::setSkirtHeight ( float skirtHeight)
inline

Set the height of the skirt to render around the edge of HeightField.

The skirt is used as a means of disguising edge boundaries between adjacent HeightField, particularly of ones with different resolutions.

References _skirtHeight.

◆ setXInterval()

void osg::HeightField::setXInterval ( float dx)
inline

References _dx.

◆ setYInterval()

void osg::HeightField::setYInterval ( float dy)
inline

References _dy.

◆ zeroRotation()

bool osg::HeightField::zeroRotation ( ) const
inline

References _rotation.

Member Data Documentation

◆ _borderWidth

unsigned int osg::HeightField::_borderWidth
protected

Referenced by getBorderWidth(), and setBorderWidth().

◆ _columns

unsigned int osg::HeightField::_columns
protected

◆ _dx

float osg::HeightField::_dx
protected

Referenced by getXInterval(), and setXInterval().

◆ _dy

float osg::HeightField::_dy
protected

Referenced by getYInterval(), and setYInterval().

◆ _heights

◆ _origin

Vec3 osg::HeightField::_origin
protected

Referenced by getOrigin(), getVertex(), and setOrigin().

◆ _rotation

Quat osg::HeightField::_rotation
protected

◆ _rows

unsigned int osg::HeightField::_rows
protected

Referenced by getNumRows().

◆ _skirtHeight

float osg::HeightField::_skirtHeight
protected

Referenced by getSkirtHeight(), and setSkirtHeight().


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

osg logo
Generated at Wed Jul 23 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.