openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::HeightField Class Reference

#include <Shape>

Inheritance diagram for osg::HeightField:
osg::Shape osg::Object osg::Referenced

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 ()
 
const FloatArraygetFloatArray () const
 
HeightListgetHeightList ()
 
const HeightListgetHeightList () const
 
void setSkirtHeight (float skirtHeight)
 
float getSkirtHeight () const
 
void setBorderWidth (unsigned int borderWidth)
 
unsigned int getBorderWidth () const
 
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
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual void accept (ShapeVisitor &)=0
 
virtual void accept (ConstShapeVisitor &) const =0
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~HeightField ()
 
- Protected Member Functions inherited from osg::Shape
virtual ~Shape ()
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- 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::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Member Typedef Documentation

◆ HeightList

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

Constructor & Destructor Documentation

◆ HeightField() [1/2]

osg::HeightField::HeightField ( )

◆ 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

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

◆ getFloatArray() [1/2]

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

Get the FloatArray height data.

◆ getFloatArray() [2/2]

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

Get the const FloatArray height data.

◆ getHeight() [1/2]

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

◆ getHeight() [2/2]

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

◆ getHeightDelta()

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

◆ getHeightList() [1/2]

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

◆ getHeightList() [2/2]

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

◆ getNormal()

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

◆ getNumColumns()

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

◆ getNumRows()

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

◆ getOrigin()

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

◆ getRotation()

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

◆ getSkirtHeight()

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

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

◆ getVertex()

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

◆ getXInterval()

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

◆ getYInterval()

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

◆ META_Shape()

osg::HeightField::META_Shape ( osg  ,
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.

◆ setHeight()

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

◆ setOrigin()

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

◆ setRotation()

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

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

◆ setXInterval()

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

◆ setYInterval()

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

◆ zeroRotation()

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

Member Data Documentation

◆ _borderWidth

unsigned int osg::HeightField::_borderWidth
protected

◆ _columns

unsigned int osg::HeightField::_columns
protected

◆ _dx

float osg::HeightField::_dx
protected

◆ _dy

float osg::HeightField::_dy
protected

◆ _heights

ref_ptr<FloatArray> osg::HeightField::_heights
protected

◆ _origin

Vec3 osg::HeightField::_origin
protected

◆ _rotation

Quat osg::HeightField::_rotation
protected

◆ _rows

unsigned int osg::HeightField::_rows
protected

◆ _skirtHeight

float osg::HeightField::_skirtHeight
protected

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