cEffectMagnet Class Reference
[Haptic Effects]

cEffectMagnet models the reaction force on a tool located near a magnet field. More...

#include <CEffectMagnet.h>

Inheritance diagram for cEffectMagnet:

[legend]

List of all members.

Public Member Functions
	cEffectMagnet (cGenericObject *a_parent)
	Constructor of cEffectMagnet.
virtual	~cEffectMagnet ()
	Destructor of cEffectMagnet.
bool	computeForce (const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int &a_toolID, cVector3d &a_reactionForce)
	Compute resulting force.

---

Detailed Description

cEffectMagnet models the reaction force on a tool located near a magnet field.

---

Constructor & Destructor Documentation

cEffectMagnet::cEffectMagnet

(

cGenericObject *

a_parent

)

Constructor of cEffectMagnet.

Constructor of cEffectMagnet.

Parameters:

a_parent

Parent object.

---

Member Function Documentation

bool cEffectMagnet::computeForce	(	const cVector3d &	a_toolPos,
		const cVector3d &	a_toolVel,
		const unsigned int &	a_toolID,
		cVector3d &	a_reactionForce
	)			[virtual]

Compute resulting force.

Compute the resulting force effect.

Parameters:

	a_toolPos	Position of tool.
	a_toolVel	Velocity of tool.
	a_toolID	Identification number of force algorithm.
	a_reactionForce	Return the computed force here.

Returns:

Return false if no interaction force is computed.

Reimplemented from cGenericEffect.

---

The documentation for this class was generated from the following files:

• D:/CHAI3D/build-2-0-0/2.0.0/win32/src/effects/CEffectMagnet.h
• D:/CHAI3D/build-2-0-0/2.0.0/win32/src/effects/CEffectMagnet.cpp