This class implements a haptic stick and slip effect. More...

Inheritance diagram for chai3d::cEffectStickSlip:

Public Member Functions
	cEffectStickSlip (cGenericObject *a_parent)
	Constructor of cEffectStickSlip. More...

virtual	~cEffectStickSlip ()
	Destructor of cEffectStickSlip. More...

bool	computeForce (const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int &a_toolID, cVector3d &a_reactionForce)
	This method computes the resulting force effect. More...

Public Member Functions inherited from chai3d::cGenericEffect
	cGenericEffect (cGenericObject *a_parent)
	Constructor of CGenericEffect. More...

virtual	~cGenericEffect ()
	Destructor of CGenericEffect. More...

void	setEnabled (bool a_enabled)
	This method enables or disables this effect. More...

bool	getEnabled () const
	This method returns true if this effect is enables, false otherwise. More...

Protected Attributes
cStickSlipStatus	m_history [C_EFFECT_MAX_IDN]
	Stores the algorithm history for each IDN calling this effect. More...

Protected Attributes inherited from chai3d::cGenericEffect
bool	m_enabled
	Is this effect currently enabled? More...

Additional Inherited Members
Public Attributes inherited from chai3d::cGenericEffect
cGenericObject *	m_parent
	Object to which the force effects applies. More...

Protected Member Functions inherited from chai3d::cGenericEffect
virtual void	initialize ()
	This method initializes the haptic effect model. More...

Detailed Description

This class implements a haptic stick and slip effect.

Constructor & Destructor Documentation

chai3d::cEffectStickSlip::cEffectStickSlip ( cGenericObject * a_parent )

Parameters

a_parent Parent object.

virtual chai3d::cEffectStickSlip::~cEffectStickSlip ( )

inlinevirtual

bool chai3d::cEffectStickSlip::computeForce	(	const cVector3d &	a_toolPos,
		const cVector3d &	a_toolVel,
		const unsigned int &	a_toolID,
		cVector3d &	a_reactionForce
	)

virtual

This method computes the resulting force effect.

Parameters

a_toolPos	Position of tool.
a_toolVel	Velocity of tool.
a_toolID	Identification number of the force algorithm stored in the tool.
a_reactionForce	Return value for the computed force.

cStickSlipStatus chai3d::cEffectStickSlip::m_history[C_EFFECT_MAX_IDN]

protected

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