OIS::LinuxForceFeedback Class Reference

#include <LinuxForceFeedback.h>

Inheritance diagram for OIS::LinuxForceFeedback:

[legend]

Collaboration diagram for OIS::LinuxForceFeedback:

[legend]

List of all members.

Public Member Functions
	LinuxForceFeedback ()
	~LinuxForceFeedback ()
void	setMasterGain (float)
void	setAutoCenterMode (bool)
void	upload (const Effect *effect)
void	modify (const Effect *effect)
void	remove (const Effect *effect)
short int	getFFAxesNumber ()

---

Detailed Description

Definition at line 31 of file LinuxForceFeedback.h.

---

Constructor & Destructor Documentation

LinuxForceFeedback::LinuxForceFeedback

(

)

Definition at line 29 of file LinuxForceFeedback.cpp.

LinuxForceFeedback::~LinuxForceFeedback

(

)

Definition at line 33 of file LinuxForceFeedback.cpp.

---

Member Function Documentation

void LinuxForceFeedback::setMasterGain

(

float

)

[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).

Implements OIS::ForceFeedback.

Definition at line 38 of file LinuxForceFeedback.cpp.

void LinuxForceFeedback::setAutoCenterMode

(

bool

)

[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.

Implements OIS::ForceFeedback.

Definition at line 43 of file LinuxForceFeedback.cpp.

void LinuxForceFeedback::upload

(

const Effect *

effect

)

[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

Implements OIS::ForceFeedback.

Definition at line 48 of file LinuxForceFeedback.cpp.

void LinuxForceFeedback::modify

(

const Effect *

effect

)

[virtual]

Remarks:

Modifies an effect that is currently playing

Implements OIS::ForceFeedback.

Definition at line 53 of file LinuxForceFeedback.cpp.

void LinuxForceFeedback::remove

(

const Effect *

effect

)

[virtual]

Remarks:

Remove the effect from the device

Implements OIS::ForceFeedback.

Definition at line 58 of file LinuxForceFeedback.cpp.

short int OIS::LinuxForceFeedback::getFFAxesNumber

(

)

[inline, virtual]

FF is not yet implemented fully on Linux.. just retun 0 for now. todo, xxx

Implements OIS::ForceFeedback.

Definition at line 53 of file LinuxForceFeedback.h.

---

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

• E:/Download/ois-1.0RC1/includes/linux/LinuxForceFeedback.h
• E:/Download/ois-1.0RC1/src/linux/LinuxForceFeedback.cpp

---