OIS::Effect Class Reference

#include <OISEffect.h>

List of all members.

Public Types

enum  EForce {
  UnknownForce = 0, ConstantForce, RampForce, PeriodicForce,
  ConditionalForce, CustomForce
}
 Type of force. More...
enum  EType {
  Unknown = 0, Constant, Ramp, Square,
  Triangle, Sine, SawToothUp, SawToothDown,
  Friction, Damper, Inertia, Spring,
  Custom
}
 Type of effect. More...
enum  EDirection {
  NorthWest, North, NorthEast, East,
  SouthEast, South, SouthWest, West
}
 Direction of the Force. More...

Public Member Functions

 Effect (EForce ef, EType et)
virtual ~Effect ()
ForceEffectgetForceEffect () const
void setNumAxes (short nAxes)
short getNumAxes () const

Public Attributes

const EForce force
const EType type
EDirection direction
short trigger_button
unsigned int trigger_interval
unsigned int replay_length
unsigned int replay_delay
int _handle

Static Public Attributes

static const unsigned int OIS_INFINITE = 0xFFFFFFFF

Protected Attributes

ForceEffecteffect
short axes

Private Member Functions

 Effect ()


Detailed Description

Force Feedback is a relatively complex set of properties to upload to a device. The best place for information on the different properties, effects, etc is in the DX Documentation and MSDN - there are even pretty graphs ther =) As this class is modeled on the the DX interface you can apply that same knowledge to creating effects via this class on any OS supported by OIS.

In anycase, this is the main class you will be using. There is *absolutely* no need to instance any of the supporting ForceEffect classes yourself.


Member Enumeration Documentation

enum OIS::Effect::EForce

Type of force.

Enumerator:
UnknownForce 
ConstantForce 
RampForce 
PeriodicForce 
ConditionalForce 
CustomForce 

enum OIS::Effect::EType

Type of effect.

Enumerator:
Unknown 
Constant 
Ramp 
Square 
Triangle 
Sine 
SawToothUp 
SawToothDown 
Friction 
Damper 
Inertia 
Spring 
Custom 

enum OIS::Effect::EDirection

Direction of the Force.

Enumerator:
NorthWest 
North 
NorthEast 
East 
SouthEast 
South 
SouthWest 
West 


Constructor & Destructor Documentation

OIS::Effect::Effect (  )  [private]

hidden so this class cannot be instanced with default constructor

OIS::Effect::Effect ( EForce  ef,
EType  et 
)

This constructor allows you to set the force type and effect.

virtual OIS::Effect::~Effect (  )  [virtual]


Member Function Documentation

ForceEffect* OIS::Effect::getForceEffect (  )  const

void OIS::Effect::setNumAxes ( short  nAxes  ) 

Remarks:
Set the number of Axes to use before the initial creation of the effect. Can only be done prior to creation! Use the FF interface to determine how many axes can be used (are availiable)

short OIS::Effect::getNumAxes (  )  const

Remarks:
Returns the number of axes used in this effect


Member Data Documentation

const EForce OIS::Effect::force

const EType OIS::Effect::type

const unsigned int OIS::Effect::OIS_INFINITE = 0xFFFFFFFF [static]

EDirection OIS::Effect::direction

short OIS::Effect::trigger_button

unsigned int OIS::Effect::trigger_interval

unsigned int OIS::Effect::replay_length

unsigned int OIS::Effect::replay_delay

int OIS::Effect::_handle [mutable]

set internally.. do not change or you will not be able to upload/stop this effect any more. It will become lost. It is mutable so even with const reference it can/will be changed by this lib

ForceEffect* OIS::Effect::effect [protected]

short OIS::Effect::axes [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