OIS::ForceFeedback Class Reference

#include <OISForceFeedback.h>

Inheritance diagram for OIS::ForceFeedback:

OIS::Interface List of all members.

Public Types

typedef std::map< Effect::EForce,
Effect::EType
SupportedEffectList

Public Member Functions

 ForceFeedback ()
virtual ~ForceFeedback ()
virtual void setMasterGain (float level)=0
virtual void setAutoCenterMode (bool auto_on)=0
virtual void upload (const Effect *effect)=0
virtual void modify (const Effect *effect)=0
virtual void remove (const Effect *effect)=0
virtual short getFFAxesNumber ()=0
const SupportedEffectListgetSupportedEffects () const
void _addEffectTypes (Effect::EForce force, Effect::EType type)

Protected Attributes

SupportedEffectList mSupportedEffects

Detailed Description

Interface class for dealing with Force Feedback devices


Member Typedef Documentation

typedef std::map<Effect::EForce, Effect::EType> OIS::ForceFeedback::SupportedEffectList


Constructor & Destructor Documentation

OIS::ForceFeedback::ForceFeedback (  )  [inline]

virtual OIS::ForceFeedback::~ForceFeedback (  )  [inline, virtual]


Member Function Documentation

virtual void OIS::ForceFeedback::setMasterGain ( float  level  )  [pure virtual]

Remarks:
This is like setting the master volume of an audio device. Individual effects have gain levels; however, this affects all effects at once.
Parameters:
level A value between 0.0 and 1.0 represent the percentage of gain. 1.0 being the highest possible force level (means no scaling).

virtual void OIS::ForceFeedback::setAutoCenterMode ( bool  auto_on  )  [pure virtual]

Remarks:
If using Force Feedback effects, this should be turned off before uploading any effects. Auto centering is the motor moving the joystick back to center. DirectInput only has an on/off setting, whereas linux has levels.. Though, we go with DI's on/off mode only
Parameters:
auto_on true to turn auto centering on, false to turn off.

virtual void OIS::ForceFeedback::upload ( const Effect effect  )  [pure virtual]

Remarks:
Creates and Plays the effect immediately. If the device is full of effects, it will fail to be uploaded. You will know this by an invalid Effect Handle

virtual void OIS::ForceFeedback::modify ( const Effect effect  )  [pure virtual]

Remarks:
Modifies an effect that is currently playing

virtual void OIS::ForceFeedback::remove ( const Effect effect  )  [pure virtual]

Remarks:
Remove the effect from the device

virtual short OIS::ForceFeedback::getFFAxesNumber (  )  [pure virtual]

Remarks:
Get the number of supported Axes for FF usage

const SupportedEffectList& OIS::ForceFeedback::getSupportedEffects (  )  const

Remarks:
Get a list of all supported effects

void OIS::ForceFeedback::_addEffectTypes ( Effect::EForce  force,
Effect::EType  type 
)


Member Data Documentation

SupportedEffectList OIS::ForceFeedback::mSupportedEffects [protected]


The documentation for this class was generated from the following file:
Generated on Fri Jul 13 21:21:05 2007 for OIS by  doxygen 1.5.2