VHTK::PrimitivesMode Class Reference
[Volume Haptics Nodes]

This haptic mode renders haptic primitives from specified parameters, i e position, primitive type, strength and orientation. More...

Inheritance diagram for VHTK::PrimitivesMode:

[legend]

List of all members.

Public Member Functions
	PrimitivesMode ()
	Initializes the internal data.
void	getPrimitives (primitives_t &r, const state &s)
	System function.
void	initialize ()
	Initializes node functionality.
Public Attributes
auto_ptr< TSMField(H3D::MFString) >	type
	The primitive types(s).
auto_ptr< TSMField(H3D::MFFloat) >	strength
	The strength of the primitive(s).
auto_ptr< TSMField(H3D::MFVec3f) >	orientation
	The orientation of the primitive(s) as normalized vector(s).
auto_ptr< TSMField(H3D::MFVec3f) >	position
	The position of the primitive(s).
auto_ptr< TSSField(H3D::SFBool) >	world
	Tells the mode if the parameters are speficied in world coordinates or not.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	X3D interface function.

---

Detailed Description

This haptic mode renders haptic primitives from specified parameters, i e position, primitive type, strength and orientation.

This mode can be used to generate feedback by routing from Python scripts or a VolumeProbe instance. Since this the parameters are updated in the graphics loop, this mode is not as fast and exact as the other modes, but with the stability of the haptic primitives it should work fine to generate prototypes for new haptic schemes.

X3D Interface
	Name	Type	Default value	Description
	type	MFString	[]	The primitive types(s). One of POINT, LINE, PLANE and FORCE.
	strength	MFFloat	[]	The strength of the primitive(s).
	orientation	MFVec3f	[]	The orientation of the primitive(s) as normalized vector(s).
	position	MFVec3f	[]	The position of the primitive(s). This is optional - if not set, the proxy position is used.
	world	SFBool	false	Tells the mode if the parameters are speficied in world coordinates or not.
Derived from VHTKHapticModeNode
	enabled	SFBool	TRUE	Specifies if this haptic mode should be active or not

---

Constructor & Destructor Documentation

VHTK::PrimitivesMode::PrimitivesMode

(

)

Initializes the internal data.

---

Member Function Documentation

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

System function.

Implements VHTK::VHTKHapticModeNode.

void VHTK::PrimitivesMode::initialize

(

)

[virtual]

Initializes node functionality.

Reimplemented from H3DUtil::RefCountedClass.

---

Member Data Documentation

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

X3D interface function.

Reimplemented from VHTK::VHTKHapticModeNode.

auto_ptr< TSMField( H3D::MFVec3f ) > VHTK::PrimitivesMode::orientation

The orientation of the primitive(s) as normalized vector(s).

If the vector is not normalized, the result is unpredictable and most probably wrong.

auto_ptr< TSMField( H3D::MFVec3f ) > VHTK::PrimitivesMode::position

The position of the primitive(s).

This is optional - if not set, the proxy position is used.

auto_ptr< TSMField( H3D::MFFloat ) > VHTK::PrimitivesMode::strength

The strength of the primitive(s).

auto_ptr< TSMField( H3D::MFString ) > VHTK::PrimitivesMode::type

The primitive types(s).

One of POINT, LINE, PLANE and FORCE. Some types do not need all parameters, but if several primitives are active dummy variables must be used so that all parameters match one-to-one with a primitive.

auto_ptr< TSSField( H3D::SFBool ) > VHTK::PrimitivesMode::world

Tells the mode if the parameters are speficied in world coordinates or not.