VHTK::ScalarGradientForceMode Class Reference
[Volume Haptics Nodes]

Inheritance diagram for VHTK::ScalarGradientForceMode:

[legend]

List of all members.

---

Detailed Description

The scalar gradient force mode generates a force based on the gradient vector direction and the material property of the volume.

X3D Interface
	Name	Type	Default value	Description
	gradientStrength	SFTransferFunction	1	The strength of the force from the gradient magnitude
	scalarStrength	SFTransferFunction	1	The strength of the force from the scalar value
Derived from VHTKScalarModeNode
	scalarVolume	SFScalarVolume	null
Derived from VHTKHapticModeNode
	active	SFBool	TRUE	Specifies if this haptic mode should be active or not

Public Member Functions
	ScalarGradientForceMode ()
	Initializes the internal data.
void	getPrimitives (primitives_t &r, const state &s)
	System function.
void	initialize ()
	Initializes node functionality.
Public Attributes
auto_ptr < H3D::ThreadSafeRefSField < SFTransferFunction > >	gradientStrength
	The strength of the force from the gradient magnitude.
auto_ptr < H3D::ThreadSafeRefSField < SFTransferFunction > >	scalarStrength
	The strength of the force from the scalar value.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	X3D interface function.

---

Constructor & Destructor Documentation

VHTK::ScalarGradientForceMode::ScalarGradientForceMode

(

)

Initializes the internal data.

---

Member Function Documentation

void VHTK::ScalarGradientForceMode::getPrimitives	(	primitives_t &	r,
		const state &	s
	)			[virtual]

System function.

Implements VHTK::VHTKHapticModeNode.

void VHTK::ScalarGradientForceMode::initialize

(

)

[virtual]

Initializes node functionality.

Reimplemented from VHTK::VHTKScalarModeNode.

---

Member Data Documentation

auto_ptr<H3D::ThreadSafeRefSField< SFTransferFunction > > VHTK::ScalarGradientForceMode::gradientStrength

The strength of the force from the gradient magnitude.

The strength of the feedback is expressed as gradientStrength times scalarStrength and if one is missing, the value 1 (one) is used for that function.

auto_ptr<H3D::ThreadSafeRefSField< SFTransferFunction > > VHTK::ScalarGradientForceMode::scalarStrength

The strength of the force from the scalar value.

The strength of the feedback is expressed as gradientStrength times scalarStrength and if one is missing, the value 1 (one) is used for that function.

H3D::H3DNodeDatabase VHTK::ScalarGradientForceMode::database [static]

X3D interface function.

Reimplemented from VHTK::VHTKScalarModeNode.