chai3d::cEffectSurface Class Reference

This class implements a haptic surface effect. More...

#include <CEffectSurface.h>

Inheritance diagram for chai3d::cEffectSurface:

Public Member Functions

 cEffectSurface (cGenericObject *a_parent)
 Constructor of cEffectSurface. More...
 
virtual ~cEffectSurface ()
 Destructor of cEffectSurface. 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...
 

Additional Inherited Members

- Public Attributes inherited from chai3d::cGenericEffect
cGenericObjectm_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...
 
- Protected Attributes inherited from chai3d::cGenericEffect
bool m_enabled
 Is this effect currently enabled? More...
 

Detailed Description

This class implements a haptic vibration effect. The associated force model creates a reaction force that pushes the tool outside of the object.

Constructor & Destructor Documentation

chai3d::cEffectSurface::cEffectSurface ( cGenericObject a_parent)

Constructor of cEffectSurface.

Parameters
a_parentParent object.
virtual chai3d::cEffectSurface::~cEffectSurface ( )
inlinevirtual

Member Function Documentation

bool chai3d::cEffectSurface::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_toolPosPosition of tool.
a_toolVelVelocity of tool.
a_toolIDIdentification number of the force algorithm stored in the tool.
a_reactionForceReturn value for the computed force.
Returns
false if no interaction force occurs, true otherwise.

Reimplemented from chai3d::cGenericEffect.


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