SoHeightFieldDetail Class Reference
[Details]

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

#include <VolumeViz/details/SoHeightFieldDetail.h>

Inheritance diagram for SoHeightFieldDetail:
SoDetail SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
 SoHeightFieldDetail ()
virtual ~SoHeightFieldDetail ()
double getValue (size_t propertyNumber) const
size_t getNumProperties () const
void getProperty (size_t propertyNumber, SoHeightFieldProperty *&property, int &id) const
const SbVec3i32getIjkPos () const
float getHeight () const
const SbVec4i32getColor () const
virtual SoDetailcopy () const

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

VolumeViz 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

SEE ALSO

SoDetail, SoHeightFieldProperty, SoHeightFieldGeometry, SoHeightFieldRender


Constructor & Destructor Documentation

SoHeightFieldDetail::SoHeightFieldDetail (  ) 

Constructor.

virtual SoHeightFieldDetail::~SoHeightFieldDetail (  )  [virtual]

Destructor.


Member Function Documentation

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.

static SoType SoHeightFieldDetail::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoDetail.

const SbVec4i32& SoHeightFieldDetail::getColor (  )  const [inline]

Returns the color of the picked cell.

float SoHeightFieldDetail::getHeight (  )  const [inline]

Get the height value of the nearest elevation point.

const SbVec3i32& SoHeightFieldDetail::getIjkPos (  )  const

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

size_t SoHeightFieldDetail::getNumProperties (  )  const [inline]

Returns the number of active properties.

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.
virtual SoType SoHeightFieldDetail::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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:

Open Inventor Toolkit reference manual, generated on 11 Nov 2019
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/