OIS::Effect Class Reference

Force Feedback is a relatively complex set of properties to upload to a device. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/OISEffect.h>

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

Public Member Functions
	Effect (EForce ef, EType et)
	This constructor allows you to set the force type and effect. More...
virtual	~Effect ()
ForceEffect *	getForceEffect () const
short	getNumAxes () const
void	setNumAxes (short nAxes)

Static Public Member Functions
static const char *	getDirectionName (EDirection eValue)
static const char *	getEffectTypeName (EType eValue)
static const char *	getForceTypeName (EForce eValue)

Public Attributes
int	_handle
	set internally. More...
EDirection	direction
const EForce	force
unsigned int	replay_delay
unsigned int	replay_length
short	trigger_button
unsigned int	trigger_interval
const EType	type

Static Public Attributes
static const unsigned int	OIS_INFINITE = 0xFFFFFFFF

Protected Attributes
short	axes
ForceEffect *	effect

Private Member Functions
	Effect ()
	hidden so this class cannot be instanced with default constructor More...

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::EDirection

Direction of the Force.

Enumerator
NorthWest
North
NorthEast
East
SouthEast
South
SouthWest
West
_DirectionsNumber

enum OIS::Effect::EForce

Type of force.

Enumerator
UnknownForce
ConstantForce
RampForce
PeriodicForce
ConditionalForce
CustomForce
_ForcesNumber

enum OIS::Effect::EType

Type of effect.

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

Constructor & Destructor Documentation

Effect::Effect ( )

private

hidden so this class cannot be instanced with default constructor

Effect::Effect	(	EForce	ef,
		EType	et
	)

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

Effect::~Effect ( )

virtual

Member Function Documentation

const char * Effect::getDirectionName ( Effect::EDirection  eValue )

static

const char * Effect::getEffectTypeName ( Effect::EType  eValue )

static

ForceEffect * Effect::getForceEffect

(

)

const

const char * Effect::getForceTypeName ( Effect::EForce  eValue )

static

short Effect::getNumAxes

(

)

const

Remarks

Returns the number of axes used in this effect

void 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)

Member Data Documentation

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

short OIS::Effect::axes

protected

EDirection OIS::Effect::direction

ForceEffect* OIS::Effect::effect

protected

const EForce OIS::Effect::force

const unsigned int OIS::Effect::OIS_INFINITE = 0xFFFFFFFF

static

unsigned int OIS::Effect::replay_delay

unsigned int OIS::Effect::replay_length

short OIS::Effect::trigger_button

unsigned int OIS::Effect::trigger_interval

const EType OIS::Effect::type

---

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

• external/ois/OISEffect.h
• external/ois/OISEffect.cpp