VHTK::ScalarSurfaceFrictionMode Class Reference
[Volume Haptics Nodes]

Inheritance diagram for VHTK::ScalarSurfaceFrictionMode:

[legend]

List of all members.

---

Detailed Description

The scalar surface friction mode generates surfaces with friction from a scalar volume.

The surfaces are defined by the local gradient at the position of the proxy, so no iso-value can be specified. The strength transfer function specify the surface strength as a function of the scalar value of the volume, which provides means to specify which data of the volume that should produce haptic feedback. Friction is used in a similar way.

The distinctness function is used to control the strength of surfaces from the gradient magnitude. Since zero magnitude gradient should render no surface this function must start at zero for an input of zero.

X3D Interface
	Name	Type	Default value	Description
	strength	SFTransferFunction	null	The surface strength
	friction	SFTransferFunction	null	The surface friction
	distinctness	SFTransferFunction	null	The surface distinctness as a function of the gradient magnitude
Derived from VHTKScalarModeNode
	scalarVolume	SFScalarVolume	null	The volume to specify surfaces and material properties from
Derived from VHTKHapticModeNode
	active	SFBool	true	Specifies if this haptic mode should be active or not

Public Member Functions
	ScalarSurfaceFrictionMode ()
	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 > >	strength
	The surface strength.
auto_ptr < H3D::ThreadSafeRefSField < SFTransferFunction > >	friction
	The surface friction.
auto_ptr < H3D::ThreadSafeRefSField < SFTransferFunction > >	distinctness
	The surface distinctness as a function of the gradient magnitude.
auto_ptr < H3D::ThreadSafeSField < H3D::SFBool > >	snapdrag
	Use snapdrag effect.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	X3D interface function.

---

Constructor & Destructor Documentation

VHTK::ScalarSurfaceFrictionMode::ScalarSurfaceFrictionMode

(

)

Initializes the internal data.

---

Member Function Documentation

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

System function.

Implements VHTK::VHTKHapticModeNode.

void VHTK::ScalarSurfaceFrictionMode::initialize

(

)

[virtual]

Initializes node functionality.

Reimplemented from VHTK::VHTKScalarModeNode.

---

Member Data Documentation

auto_ptr< H3D::ThreadSafeRefSField< SFTransferFunction > > VHTK::ScalarSurfaceFrictionMode::strength

The surface strength.

auto_ptr< H3D::ThreadSafeRefSField< SFTransferFunction > > VHTK::ScalarSurfaceFrictionMode::friction

The surface friction.

auto_ptr< H3D::ThreadSafeRefSField< SFTransferFunction > > VHTK::ScalarSurfaceFrictionMode::distinctness

The surface distinctness as a function of the gradient magnitude.

auto_ptr< H3D::ThreadSafeSField< H3D::SFBool > > VHTK::ScalarSurfaceFrictionMode::snapdrag

Use snapdrag effect.

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

X3D interface function.

Reimplemented from VHTK::VHTKScalarModeNode.