osg::HeightField Class Reference

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 osg::Vec3 &origin)
const osg::Vec3 &	getOrigin () const
void	setXInterval (float dx)
float	getXInterval () const
void	setYInterval (float dy)
float	getYInterval () const
osg::FloatArray *	getFloatArray ()
	Get the FloatArray height data. More...
const osg::FloatArray *	getFloatArray () const
	Get the const FloatArray height data. More...
HeightList &	getHeightList ()
const HeightList &	getHeightList () const
void	setSkirtHeight (float skirtHeight)
	Set the height of the skirt to render around the edge of HeightField. More...
float	getSkirtHeight () const
	Get the height of the skirt to render around the edge of HeightField. More...
void	setBorderWidth (unsigned int borderWidth)
	Set the width in number of cells in from the edge that the height field should be rendered from. More...
unsigned int	getBorderWidth () const
	Get the width in number of cells in from the edge that the height field should be rendered from. More...
void	setRotation (const Quat &quat)
const Quat &	getRotation () 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 Object *	cloneType () const =0
	Clone the type of an attribute, with Object* return type. More...
virtual Object *	clone (const CopyOp &) const =0
	Clone an attribute, with Object* return type. More...
virtual bool	isSameKindAs (const Object *obj) const
	return true if this and obj are of the same kind of object. More...
virtual const char *	libraryName () const
	return the name of the attribute's library. More...
virtual const char *	className () const
	return the name of the attribute's class type. More...
virtual void	accept (ShapeVisitor &)=0
	accept a non const shape visitor which can be used on non const shape objects. More...
virtual void	accept (ConstShapeVisitor &) const =0
	accept a const shape visitor which can be used on const shape objects. More...
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...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () 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 Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () 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)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
OpenThreads::Mutex *	getRefMutex () 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...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () 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	~HeightField ()
Protected Member Functions inherited from osg::Shape
virtual	~Shape ()
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
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
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. More...
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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:

• osg/Shape