VHTK::VHTKScalarModeNode Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::VHTKScalarModeNode:

Inheritance graph
[legend]

List of all members.


Detailed Description

The abstract base class for all VHTKHapticModeNode classes that use a scalar volume as input data.

X3D Interface

 NameTypeDefault valueDescription
scalarVolume MFScalarDataNode   null   Contains a VHTKScalarDataNode that is to be used by the haptic mode.  

Public Types

typedef H3D::DependentMFNode
< VHTKScalarDataNode,
H3D::FieldRef< VHTKDataNode,
H3D::Field,&VHTKScalarDataNode::dataChanged > > 
MFScalarDataNode

Public Member Functions

 VHTKScalarModeNode (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::SFBool > _activeDynamics=0, H3D::Inst< MFVectorDataNode > _animationMotionVector=0, H3D::Inst< H3D::SFFloat > _animationMotionScale=0, H3D::Inst< H3D::SFFloat > _animationFrame=0, H3D::Inst< H3D::SFBool > _temporalInterpolation=0, H3D::Inst< H3D::SFBool > _active=0, H3D::Inst< MFScalarDataNode > _scalarVolume=0)
 Constructor.
void initialize ()
 Initializes node functionality.

Public Attributes

auto_ptr< MFScalarDataNodescalarVolume
 Contains a VHTKScalarDataNode that is to be used by the haptic mode.

Static Public Attributes

static H3D::H3DNodeDatabase database

Protected Member Functions

virtual float getScalar (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching scalar volume data.
float getScalar (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching scalar volume data.
float getScalarAtProxy (const state &s)
 Convenience function for fetching scalar volume data.
float getScalarRelativeProxy (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching scalar volume data.
virtual float getScalarRelativeProxy (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching scalar volume data.
virtual float getScalarAtProbe (const state &s)
 Convenience function for fetching scalar volume data.
float getScalarRelativeProbe (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching scalar volume data.
virtual float getScalarRelativeProbe (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching scalar volume data.
virtual H3D::Vec3f getGradient (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching gradient from scalar volume data.
H3D::Vec3f getGradient (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching gradient from scalar volume data.
H3D::Vec3f getGradientAtProxy (const state &s)
 Convenience function for fetching gradient from scalar volume data.
H3D::Vec3f getGradientRelativeProxy (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching gradient from scalar volume data.
virtual H3D::Vec3f getGradientRelativeProxy (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching gradient from scalar volume data.
H3D::Vec3f getGradientAtProbe (const state &s)
 Convenience function for fetching gradient from scalar volume data.
H3D::Vec3f getGradientRelativeProbe (const state &s, const HAPI::Vec3 &x)
 Convenience function for fetching gradient from scalar volume data.
virtual H3D::Vec3f getGradientRelativeProbe (const state &s, const H3D::Vec3f &x)
 Convenience function for fetching gradient from scalar volume data.


Constructor & Destructor Documentation

VHTK::VHTKScalarModeNode::VHTKScalarModeNode ( H3D::Inst< H3D::SFNode _metadata = 0,
H3D::Inst< H3D::SFBool _activeDynamics = 0,
H3D::Inst< MFVectorDataNode _animationMotionVector = 0,
H3D::Inst< H3D::SFFloat _animationMotionScale = 0,
H3D::Inst< H3D::SFFloat _animationFrame = 0,
H3D::Inst< H3D::SFBool _temporalInterpolation = 0,
H3D::Inst< H3D::SFBool _active = 0,
H3D::Inst< MFScalarDataNode _scalarVolume = 0 
)

Constructor.


Member Function Documentation

void VHTK::VHTKScalarModeNode::initialize (  )  [virtual]

virtual float VHTK::VHTKScalarModeNode::getScalar ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching scalar volume data.

float VHTK::VHTKScalarModeNode::getScalar ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching scalar volume data.

float VHTK::VHTKScalarModeNode::getScalarAtProxy ( const state s  )  [inline, protected]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

float VHTK::VHTKScalarModeNode::getScalarRelativeProxy ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual float VHTK::VHTKScalarModeNode::getScalarRelativeProxy ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual float VHTK::VHTKScalarModeNode::getScalarAtProbe ( const state s  )  [inline, protected, virtual]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

float VHTK::VHTKScalarModeNode::getScalarRelativeProbe ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual float VHTK::VHTKScalarModeNode::getScalarRelativeProbe ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual H3D::Vec3f VHTK::VHTKScalarModeNode::getGradient ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching gradient from scalar volume data.

H3D::Vec3f VHTK::VHTKScalarModeNode::getGradient ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching gradient from scalar volume data.

H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientAtProxy ( const state s  )  [inline, protected]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.

H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientRelativeProxy ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientRelativeProxy ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.

H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientAtProbe ( const state s  )  [inline, protected]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.

H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientRelativeProbe ( const state s,
const HAPI::Vec3 x 
) [inline, protected]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.

virtual H3D::Vec3f VHTK::VHTKScalarModeNode::getGradientRelativeProbe ( const state s,
const H3D::Vec3f &  x 
) [protected, virtual]

Convenience function for fetching gradient from scalar volume data.

This function performs temporal interpolation if that features is activated.


Member Data Documentation

Contains a VHTKScalarDataNode that is to be used by the haptic mode.


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