cEffectStickSlip Class Reference
[Haptic Effects]

cEffectStickSlip models a stick and slip effect. More...

#include <CEffectStickSlip.h>

Inheritance diagram for cEffectStickSlip:

Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Protected Attributes

cStickSlipStatus m_history [CHAI_EFFECT_MAX_IDN]
 store the algorithm history for each IDN calling this effect.


Detailed Description

cEffectStickSlip models a stick and slip effect.

Constructor & Destructor Documentation

cEffectStickSlip::cEffectStickSlip ( cGenericObject a_parent  ) 

Constructor of cEffectStickSlip.

Constructor of cEffectStickSlip.

Parameters:
a_parent Parent object.


Member Function Documentation

bool cEffectStickSlip::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:


CHAI3D 2.0.0 documentation
Please address any questions to support@chai3d.org
(C) 2003-2009 - CHAI 3D
All Rights Reserved.