VHTK::VectorVortexMode Class Reference
[Volume Haptics Nodes]

Inheritance diagram for VHTK::VectorVortexMode:

[legend]

List of all members.

---

Detailed Description

The vector vortex-mode give a tube like feeling from the vorticity in vector fields.

When a vortex is present a "shell" is rendered around its core. This shell also gets the shape of the vorticity around the vortex core.

X3D Interface
	Name	Type	Default value	Description
	strength	SFTransferFunction	null	The strength of the shell from the curl magnitude
	twoSided	SFBool	(false)	If false the effect is single sided
	snapdrag	SFBool	false	Use the snapdrag effect.
Derived from VHTKVectorModeNode
	vectorVolume	SFVectorVolume	null	The volume to feel and specify the material properties from
Derived from VHTKHapticModeNode
	active	SFBool	TRUE	Specifies if this haptic mode should be active or not

Public Member Functions
	VectorVortexMode ()
	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 strength of the shell from the curl magnitude.
auto_ptr < H3D::ThreadSafeSField < H3D::SFBool > >	twoSided
	If false the effect is single sided.
auto_ptr < H3D::ThreadSafeSField < H3D::SFBool > >	snapdrag
	Use snapdrag effect.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	X3D interface function.

---

Constructor & Destructor Documentation

VHTK::VectorVortexMode::VectorVortexMode

(

)

Initializes the internal data.

---

Member Function Documentation

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

System function.

Implements VHTK::VHTKHapticModeNode.

void VHTK::VectorVortexMode::initialize

(

)

[virtual]

Initializes node functionality.

Reimplemented from VHTK::VHTKVectorModeNode.

---

Member Data Documentation

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

The strength of the shell from the curl magnitude.

auto_ptr< H3D::ThreadSafeSField< H3D::SFBool > > VHTK::VectorVortexMode::twoSided

If false the effect is single sided.

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

Use snapdrag effect.

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

X3D interface function.

Reimplemented from VHTK::VHTKVectorModeNode.