#include <src/ois/OISEffect.h>
Public Types | |
enum | EDirection { NorthWest, North, NorthEast, East, SouthEast, South, SouthWest, West } |
Direction of the Force. More... | |
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... | |
Public Member Functions | |
Effect (EForce ef, EType et) | |
ForceEffect * | getForceEffect () const |
short | getNumAxes () const |
void | setNumAxes (short nAxes) |
virtual | ~Effect () |
Public Attributes | |
int | _handle |
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 () |
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.
enum OIS::Effect::EForce |
enum OIS::Effect::EType |
Effect::Effect | ( | ) | [private] |
hidden so this class cannot be instanced with default constructor
This constructor allows you to set the force type and effect.
References ConditionalForce, ConstantForce, effect, PeriodicForce, and RampForce.
Effect::~Effect | ( | ) | [virtual] |
References effect.
ForceEffect * Effect::getForceEffect | ( | ) | const |
short Effect::getNumAxes | ( | ) | const |
References axes.
Referenced by OIS::Win32ForceFeedback::_setCommonProperties().
void Effect::setNumAxes | ( | short | nAxes | ) |
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
Referenced by OIS::Win32ForceFeedback::_upload(), OIS::Win32ForceFeedback::remove(), and setNumAxes().
short OIS::Effect::axes [protected] |
Referenced by getNumAxes(), and setNumAxes().
ForceEffect* OIS::Effect::effect [protected] |
Referenced by Effect(), getForceEffect(), and ~Effect().
const EForce OIS::Effect::force |
Referenced by OIS::Win32ForceFeedback::upload().
const unsigned int OIS::Effect::OIS_INFINITE = 0xFFFFFFFF [static] |
unsigned int OIS::Effect::replay_delay |
Referenced by OIS::Win32ForceFeedback::_setCommonProperties().
unsigned int OIS::Effect::replay_length |
Referenced by OIS::Win32ForceFeedback::_setCommonProperties().
unsigned int OIS::Effect::trigger_interval |
const EType OIS::Effect::type |