openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::HeightField Class Reference
Inheritance diagram for osg::HeightField:
osg::Shape osg::Object osg::Referenced

Public Types

typedef std::vector< float > HeightList

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 osg::Vec3 &origin)
const osg::Vec3getOrigin () const
void setXInterval (float dx)
float getXInterval () const
void setYInterval (float dy)
float getYInterval () const
osg::FloatArraygetFloatArray ()
const osg::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)
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)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
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
- 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
osg::Vec3 _origin
float _dx
float _dy
float _skirtHeight
unsigned int _borderWidth
Quat _rotation
osg::ref_ptr< osg::FloatArray_heights

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

Member Typedef Documentation

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

Constructor & Destructor Documentation

osg::HeightField::HeightField ( )
osg::HeightField::HeightField ( const HeightField mesh,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
virtual osg::HeightField::~HeightField ( )
protectedvirtual

Member Function Documentation

void osg::HeightField::allocate ( unsigned int  numColumns,
unsigned int  numRows 
)
Matrix osg::HeightField::computeRotationMatrix ( ) const
inline
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.

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

Get the FloatArray height data.

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

Get the const FloatArray height data.

float& osg::HeightField::getHeight ( unsigned int  c,
unsigned int  r 
)
inline
float osg::HeightField::getHeight ( unsigned int  c,
unsigned int  r 
) const
inline
Vec2 osg::HeightField::getHeightDelta ( unsigned int  c,
unsigned int  r 
) const
HeightList& osg::HeightField::getHeightList ( )
inline
const HeightList& osg::HeightField::getHeightList ( ) const
inline
Vec3 osg::HeightField::getNormal ( unsigned int  c,
unsigned int  r 
) const
unsigned int osg::HeightField::getNumColumns ( ) const
inline
unsigned int osg::HeightField::getNumRows ( ) const
inline
const osg::Vec3& osg::HeightField::getOrigin ( ) const
inline
const Quat& osg::HeightField::getRotation ( ) const
inline
float osg::HeightField::getSkirtHeight ( ) const
inline

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

Vec3 osg::HeightField::getVertex ( unsigned int  c,
unsigned int  r 
) const
inline
float osg::HeightField::getXInterval ( ) const
inline
float osg::HeightField::getYInterval ( ) const
inline
osg::HeightField::META_Shape ( osg  ,
HeightField   
)
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.

void osg::HeightField::setHeight ( unsigned int  c,
unsigned int  r,
float  value 
)
inline
void osg::HeightField::setOrigin ( const osg::Vec3 origin)
inline
void osg::HeightField::setRotation ( const Quat quat)
inline
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.

void osg::HeightField::setXInterval ( float  dx)
inline
void osg::HeightField::setYInterval ( float  dy)
inline
bool osg::HeightField::zeroRotation ( ) const
inline

Member Data Documentation

unsigned int osg::HeightField::_borderWidth
protected
unsigned int osg::HeightField::_columns
protected
float osg::HeightField::_dx
protected
float osg::HeightField::_dy
protected
osg::ref_ptr<osg::FloatArray> osg::HeightField::_heights
protected
osg::Vec3 osg::HeightField::_origin
protected
Quat osg::HeightField::_rotation
protected
unsigned int osg::HeightField::_rows
protected
float osg::HeightField::_skirtHeight
protected

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