VHTK::VHTKScalarDataNode Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::VHTKScalarDataNode:

Inheritance graph
[legend]

List of all members.


Detailed Description

This is the abstract base class for all nodes containing scalar data in the Volume Haptics Toolkit(VHTK).

It declares functions for accessing a scalar value and the gradient of the scalar values.

Public Member Functions

 VHTKScalarDataNode (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::Field > _dataChanged=0, H3D::Inst< H3D::SFBool > _scaleVectors=0)
virtual float getScalar (const H3D::Matrix4f &T, const H3D::Vec3f &x)=0
 Get the scalar value at a given position in space.
float getScalar (const H3D::Vec3f &x)
 Get the scalar value at a given position in space.
virtual H3D::Vec3f getGradient (const H3D::Matrix4f &T, const H3D::Vec3f &x)=0
 Get the voxel value at a given position in space.
H3D::Vec3f getGradient (const H3D::Vec3f &x)
 Get the gradient at a given position in space.
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value.


Member Function Documentation

virtual float VHTK::VHTKScalarDataNode::getScalar ( const H3D::Matrix4f &  T,
const H3D::Vec3f &  x 
) [pure virtual]

Get the scalar value at a given position in space.

Parameters:
T is the transforation matrix from local space to the space the volume data is specified in.
x is the local position in space.

Implemented in VHTK::ScalarConstantField, VHTK::ScalarElectroPotentialField, VHTK::ScalarExtractorField, VHTK::ScalarRoutedField, and VHTK::VHTKScalarImageNode.

float VHTK::VHTKScalarDataNode::getScalar ( const H3D::Vec3f &  x  )  [inline]

Get the scalar value at a given position in space.

virtual H3D::Vec3f VHTK::VHTKScalarDataNode::getGradient ( const H3D::Matrix4f &  T,
const H3D::Vec3f &  x 
) [pure virtual]

Get the voxel value at a given position in space.

Parameters:
T is the transforation matrix from local space to the space the volume data is specified in.
x is the local position in space.

Implemented in VHTK::ScalarConstantField, VHTK::ScalarElectroPotentialField, VHTK::ScalarRoutedField, VHTK::VHTKScalarFieldNode, and VHTK::VHTKScalarImageNode.

H3D::Vec3f VHTK::VHTKScalarDataNode::getGradient ( const H3D::Vec3f &  x  )  [inline]

Get the gradient at a given position in space.

virtual string VHTK::VHTKScalarDataNode::defaultXMLContainerField (  )  [inline, virtual]

Returns the default xml containerField attribute value.

For this node it is "scalarVolume".

Reimplemented from VHTK::VHTKDataNode.


Generated on Thu Mar 5 08:46:58 2009 for Volume Haptics Toolkit by  doxygen 1.5.6