summaryrefslogtreecommitdiffhomepage
path: root/StarsEx/MotionController.h
blob: 0214d14b12bafdfd7a405248c5b732fbba5906b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*  Starshatter: The Open Source Project
    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
    Copyright (c) 1997-2006, Destroyer Studios LLC.

    AUTHOR:       John DiCamillo


    OVERVIEW
    ========
    Abstract MotionController class (hides details of Joystick, Keyboard, etc.)
*/

#ifndef MoCon_h
#define MoCon_h

// +--------------------------------------------------------------------+

struct KeyMapEntry
{
    static const char* TYPENAME() { return "KeyMapEntry"; }

    KeyMapEntry()                                : act(0), key(0), alt(0), joy(0) { }
    KeyMapEntry(int a, int k, int s=0, int j=0)  : act(a), key(k), alt(s), joy(j) { }

    int operator==(const KeyMapEntry& k) const { return act==k.act && key==k.key && alt==k.alt && joy==k.joy; }
    int operator!=(const KeyMapEntry& k) const { return !(*this==k); }

    int      act;
    int      key;
    int      alt;
    int      joy;
};

// +--------------------------------------------------------------------+

const int KEY_MAP_SIZE        = 256;
const int KEY_BASE_SIZE       =  64;
const int KEY_USER_SIZE       = KEY_MAP_SIZE - KEY_BASE_SIZE;

const int KEY_MAP_BASE        = 0;
const int KEY_MAP_END         = KEY_MAP_BASE + KEY_BASE_SIZE - 1;

const int KEY_USER_BASE       = KEY_MAP_END + 1;
const int KEY_USER_END        = KEY_USER_BASE + KEY_USER_SIZE - 1;

const int KEY_MAP_FIRST       = KEY_MAP_BASE;
const int KEY_MAP_LAST        = KEY_MAP_BASE + KEY_MAP_SIZE - 1;

// MAP NAMES:

const int KEY_PLUS_X          =  1;
const int KEY_MINUS_X         =  2;
const int KEY_PLUS_Y          =  3;
const int KEY_MINUS_Y         =  4;
const int KEY_PLUS_Z          =  5;
const int KEY_MINUS_Z         =  6;

const int KEY_PITCH_UP        =  7;
const int KEY_PITCH_DOWN      =  8;
const int KEY_YAW_LEFT        =  9;
const int KEY_YAW_RIGHT       = 10;
const int KEY_ROLL_LEFT       = 11;
const int KEY_ROLL_RIGHT      = 12;
const int KEY_CENTER          = 13;
const int KEY_ROLL_ENABLE     = 14;

const int KEY_ACTION_0        = 15;
const int KEY_ACTION_1        = 16;
const int KEY_ACTION_2        = 17;
const int KEY_ACTION_3        = 18;

const int KEY_CONTROL_MODEL   = 19;
const int KEY_MOUSE_SELECT    = 20;
const int KEY_MOUSE_SENSE     = 21;
const int KEY_MOUSE_SWAP      = 22;
const int KEY_MOUSE_INVERT    = 23;
const int KEY_MOUSE_ACTIVE    = 24;

const int KEY_JOY_SELECT      = 25;
const int KEY_JOY_THROTTLE    = 26;
const int KEY_JOY_RUDDER      = 27;
const int KEY_JOY_SENSE       = 28;
const int KEY_JOY_DEAD_ZONE   = 29;
const int KEY_JOY_SWAP        = 30;

const int KEY_AXIS_YAW        = 32;
const int KEY_AXIS_PITCH      = 33;
const int KEY_AXIS_ROLL       = 34;
const int KEY_AXIS_THROTTLE   = 35;

const int KEY_AXIS_YAW_INVERT       = 38;
const int KEY_AXIS_PITCH_INVERT     = 39;
const int KEY_AXIS_ROLL_INVERT      = 40;
const int KEY_AXIS_THROTTLE_INVERT  = 41;


// CONTROL VALUES:

// joystick buttons and switches must use
// ids greater than 255 so they don't interfere
// with extended ascii numbers for keyboard keys

const int KEY_JOY_AXIS_X      = 0x1A0;
const int KEY_JOY_AXIS_Y      = 0x1A1;
const int KEY_JOY_AXIS_Z      = 0x1A2;
const int KEY_JOY_AXIS_RX     = 0x1A3;
const int KEY_JOY_AXIS_RY     = 0x1A4;
const int KEY_JOY_AXIS_RZ     = 0x1A5;
const int KEY_JOY_AXIS_S0     = 0x1A6;
const int KEY_JOY_AXIS_S1     = 0x1A7;

const int KEY_JOY_1           = 0x1C1;
const int KEY_JOY_2           = 0x1C2;
const int KEY_JOY_3           = 0x1C3;
const int KEY_JOY_4           = 0x1C4;
const int KEY_JOY_5           = 0x1C5;
const int KEY_JOY_6           = 0x1C6;
const int KEY_JOY_7           = 0x1C7;
const int KEY_JOY_8           = 0x1C8;
const int KEY_JOY_9           = 0x1C9;
const int KEY_JOY_10          = 0x1CA;
const int KEY_JOY_11          = 0x1CB;
const int KEY_JOY_12          = 0x1CC;
const int KEY_JOY_13          = 0x1CD;
const int KEY_JOY_14          = 0x1CE;
const int KEY_JOY_15          = 0x1CF;
const int KEY_JOY_16          = 0x1D0;

const int KEY_JOY_32          = 0x1E0;

const int KEY_POV_0_UP        = 0x1F0;
const int KEY_POV_0_DOWN      = 0x1F1;
const int KEY_POV_0_LEFT      = 0x1F2;
const int KEY_POV_0_RIGHT     = 0x1F3;

const int KEY_POV_1_UP        = 0x1F4;
const int KEY_POV_1_DOWN      = 0x1F5;
const int KEY_POV_1_LEFT      = 0x1F6;
const int KEY_POV_1_RIGHT     = 0x1F7;

const int KEY_POV_2_UP        = 0x1F8;
const int KEY_POV_2_DOWN      = 0x1F9;
const int KEY_POV_2_LEFT      = 0x1FA;
const int KEY_POV_2_RIGHT     = 0x1FB;

const int KEY_POV_3_UP        = 0x1FC;
const int KEY_POV_3_DOWN      = 0x1FD;
const int KEY_POV_3_LEFT      = 0x1FE;
const int KEY_POV_3_RIGHT     = 0x1FF;

// +--------------------------------------------------------------------+

class MotionController
{
public:
    static const char* TYPENAME() { return "MotionController"; }

    MotionController()
    : status(StatusOK), sensitivity(1), dead_zone(0),
    swapped(0), inverted(0), rudder(0), throttle(0), select(0) { }

    virtual ~MotionController()   { }

    enum StatusValue { StatusOK, StatusErr, StatusBadParm };
    enum ActionValue { MaxActions = 32 };

    StatusValue    Status()          const { return status; }
    int            Sensitivity()     const { return sensitivity; }
    int            DeadZone()        const { return dead_zone;   }
    int            Swapped()         const { return swapped;     }
    int            Inverted()        const { return inverted;    }
    int            RudderEnabled()   const { return rudder;      }
    int            ThrottleEnabled() const { return throttle;    }
    int            Selector()        const { return select;      }


    // setup:
    virtual void   SetSensitivity(int sense, int dead)
    {
        if (sense > 0) sensitivity = sense;
        if (dead > 0)  dead_zone   = dead;
    }

    virtual void   SetSelector(int sel)       { select = sel;   }
    virtual void   SetRudderEnabled(int rud)  { rudder = rud;   }
    virtual void   SetThrottleEnabled(int t)  { throttle = t;   }

    virtual void   SwapYawRoll(int swap)      { swapped = swap; }
    virtual int    GetSwapYawRoll()           { return swapped; }
    virtual void   InvertPitch(int inv)       { inverted = inv; }
    virtual int    GetInverted()              { return inverted; }

    virtual void   MapKeys(KeyMapEntry* mapping, int nkeys) { }

    // sample the physical device
    virtual void   Acquire()               { }

    // translations
    virtual double X()                     { return 0; }
    virtual double Y()                     { return 0; }
    virtual double Z()                     { return 0; }

    // rotations
    virtual double Pitch()                 { return 0; }
    virtual double Roll()                  { return 0; }
    virtual double Yaw()                   { return 0; }
    virtual int    Center()                { return 0; }

    // throttle
    virtual double Throttle()              { return 0; }
    virtual void   SetThrottle(double t)   { }

    // actions
    virtual int    Action(int n)           { return 0; }
    virtual int    ActionMap(int n)        { return 0; }

protected:
    StatusValue    status;
    int            sensitivity;
    int            dead_zone;
    int            swapped;
    int            inverted;
    int            rudder;
    int            throttle;
    int            select;
};

#endif  // MoCon_h