SoHeightFieldDetail Class Reference

Stores detail information about a picked cell in a heightfield. More...

#include <VolumeViz/details/SoHeightFieldDetail.h>

Inheritance diagram for SoHeightFieldDetail:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoHeightFieldDetail ()
	Constructor.
virtual	~SoHeightFieldDetail ()
	Destructor.
double	getValue (size_t propertyNumber) const
	Returns the value of the picked cell in the specified property (SoHeightFieldProperty node).
size_t	getNumProperties () const
	Returns the number of active properties.
void	getProperty (size_t propertyNumber, SoHeightFieldProperty *&property, int &id) const
	Returns the specified property and its id.
const SbVec3i32 &	getIjkPos () const
	Returns the position in data space (cell coordinates) of the picked cell.
float	getHeight () const
	Get the height value of the nearest elevation point.
const SbVec4i32 &	getColor () const
	Returns the color of the picked cell.
virtual SoDetail *	copy () const
	Returns an instance that is a copy of this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores detail information about a picked cell in a heightfield.

A successful pick operation returns an SoPickedPoint object. If the picked geometry is an SoHeightFieldRender node, use the getDetail method and cast the result to this class to get extra information about the the pick.

SoHeightFieldDetail returns

• The i,j,k position of the picked cell (position in data space).
• The value of the picked cell retrieved from the current SoHeightFieldProperty
• or the values of the picked cell when multiple SoHeightFieldProperty nodes are inherited.
• The data set of the picked heightfield, i.e., the current SoHeightFieldProperty node.
• or the data sets of the picked heightfield, when multiple SoHeightFieldProperty nodes are inherited.

SEE ALSO

SoDetail, SoHeightFieldProperty, SoHeightFieldGeometry, SoHeightFieldRender

Definition at line 72 of file SoHeightFieldDetail.h.

Constructor & Destructor Documentation

SoHeightFieldDetail()

SoHeightFieldDetail::SoHeightFieldDetail

(

)

Constructor.

~SoHeightFieldDetail()

virtual SoHeightFieldDetail::~SoHeightFieldDetail ( )

virtual

Destructor.

Member Function Documentation

copy()

virtual SoDetail * SoHeightFieldDetail::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when it is no longer needed.

Implements SoDetail.

getClassTypeId()

static SoType SoHeightFieldDetail::getClassTypeId ( )

static

Returns the type identifier for this class.

getColor()

const SbVec4i32 & SoHeightFieldDetail::getColor ( ) const

inline

Returns the color of the picked cell.

Definition at line 123 of file SoHeightFieldDetail.h.

getHeight()

float SoHeightFieldDetail::getHeight ( ) const

inline

Get the height value of the nearest elevation point.

Definition at line 118 of file SoHeightFieldDetail.h.

getIjkPos()

const SbVec3i32 & SoHeightFieldDetail::getIjkPos

(

)

const

Returns the position in data space (cell coordinates) of the picked cell.

getNumProperties()

size_t SoHeightFieldDetail::getNumProperties ( ) const

inline

Returns the number of active properties.

Definition at line 98 of file SoHeightFieldDetail.h.

getProperty()

void SoHeightFieldDetail::getProperty	(	size_t	propertyNumber,
		SoHeightFieldProperty *&	property,
		int &	id
	)		const

Returns the specified property and its id.

Parameters

propertyNumber	is the number of the property to query. Use the getNumProperties method to get the number of properties.
property	is filled with a pointer to the queried property. NULL if propertyNumber is invalid.
id	is filled with the id of the property. -1 if propertyNumber is invalid.

getTypeId()

virtual SoType SoHeightFieldDetail::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

getValue()

double SoHeightFieldDetail::getValue

(

size_t

propertyNumber

)

const

Returns the value of the picked cell in the specified property (SoHeightFieldProperty node).

Parameters

propertyNumber

is the number of the property to query.

Returns

value. Returns NaN if propertyNumber is not valid. Use the getNumProperties method to get the number of properties.

---

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

• VolumeViz/details/SoHeightFieldDetail.h