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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/////////////////////////////////////////////////////////////////////////////
// Name: joystick.h
// Purpose: interface of wxJoystick
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxJoystick
wxJoystick allows an application to control one or more joysticks.
@library{wxadv}
@category{misc}
@see wxJoystickEvent
*/
class wxJoystick : public wxObject
{
public:
/**
Constructor.
@a joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick
controller of interest.
*/
wxJoystick(int joystick = wxJOYSTICK1);
/**
Destroys the wxJoystick object.
*/
virtual ~wxJoystick();
/**
Returns the state of the joystick buttons.
Every button is mapped to a single bit in the returned integer, with the
first button being mapped to the least significant bit, and so on.
A bitlist of wxJOY_BUTTONn identifiers, where n is 1, 2, 3 or 4 is available
for historical reasons.
*/
int GetButtonState() const;
/**
Returns the state of the specified joystick button.
@param id
The button id to report, from 0 to GetNumberButtons() - 1
*/
bool GetButtonState(unsigned int id) const;
/**
Returns the manufacturer id.
*/
int GetManufacturerId() const;
/**
Returns the movement threshold, the number of steps outside which the joystick
is deemed to have
moved.
*/
int GetMovementThreshold() const;
/**
Returns the number of axes for this joystick.
*/
int GetNumberAxes() const;
/**
Returns the number of buttons for this joystick.
*/
int GetNumberButtons() const;
/**
Returns the number of joysticks currently attached to the computer.
*/
static int GetNumberJoysticks();
/**
Returns the point-of-view position, expressed in continuous, one-hundredth of a
degree units.
Returns -1 on error.
*/
int GetPOVCTSPosition() const;
/**
Returns the point-of-view position, expressed in continuous, one-hundredth of a
degree units, but limited to return 0, 9000, 18000 or 27000.
Returns -1 on error.
*/
int GetPOVPosition() const;
/**
Returns the maximum polling frequency.
*/
int GetPollingMax() const;
/**
Returns the minimum polling frequency.
*/
int GetPollingMin() const;
/**
Returns the x, y position of the joystick.
*/
wxPoint GetPosition() const;
/**
Returns the position of the specified joystick axis.
@param axis
The joystick axis to report, from 0 to GetNumberAxes() - 1.
*/
int GetPosition(unsigned int axis) const;
/**
Returns the product id for the joystick.
*/
int GetProductId() const;
/**
Returns the product name for the joystick.
*/
wxString GetProductName() const;
/**
Returns the maximum rudder position.
*/
int GetRudderMax() const;
/**
Returns the minimum rudder position.
*/
int GetRudderMin() const;
/**
Returns the rudder position.
*/
int GetRudderPosition() const;
/**
Returns the maximum U position.
*/
int GetUMax() const;
/**
Returns the minimum U position.
*/
int GetUMin() const;
/**
Gets the position of the fifth axis of the joystick, if it exists.
*/
int GetUPosition() const;
/**
Returns the maximum V position.
*/
int GetVMax() const;
/**
Returns the minimum V position.
*/
int GetVMin() const;
/**
Gets the position of the sixth axis of the joystick, if it exists.
*/
int GetVPosition() const;
/**
Returns the maximum x position.
*/
int GetXMax() const;
/**
Returns the minimum x position.
*/
int GetXMin() const;
/**
Returns the maximum y position.
*/
int GetYMax() const;
/**
Returns the minimum y position.
*/
int GetYMin() const;
/**
Returns the maximum z position.
*/
int GetZMax() const;
/**
Returns the minimum z position.
*/
int GetZMin() const;
/**
Returns the z position of the joystick.
*/
int GetZPosition() const;
/**
Returns @true if the joystick has a point of view control.
*/
bool HasPOV() const;
/**
Returns @true if the joystick point-of-view supports discrete values
(centered, forward, backward, left, and right).
*/
bool HasPOV4Dir() const;
/**
Returns @true if the joystick point-of-view supports continuous degree bearings.
*/
bool HasPOVCTS() const;
/**
Returns @true if there is a rudder attached to the computer.
*/
bool HasRudder() const;
/**
Returns @true if the joystick has a U axis.
*/
bool HasU() const;
/**
Returns @true if the joystick has a V axis.
*/
bool HasV() const;
/**
Returns @true if the joystick has a Z axis.
*/
bool HasZ() const;
/**
Returns @true if the joystick is functioning.
*/
bool IsOk() const;
/**
Releases the capture set by @b SetCapture.
@return @true if the capture release succeeded.
@see SetCapture(), wxJoystickEvent
*/
bool ReleaseCapture();
/**
Sets the capture to direct joystick events to @a win.
@param win
The window that will receive joystick events.
@param pollingFreq
If zero, movement events are sent when above the threshold.
If greater than zero, events are received every @a pollingFreq milliseconds.
@return @true if the capture succeeded.
@see ReleaseCapture(), wxJoystickEvent
*/
bool SetCapture(wxWindow* win, int pollingFreq = 0);
/**
Sets the movement threshold, the number of steps outside which the joystick is
deemed to have moved.
*/
void SetMovementThreshold(int threshold);
};
|
