File: qgs2dgamepadcontroller.sip.in

package info (click to toggle)
qgis 3.40.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,181,336 kB
  • sloc: cpp: 1,593,302; python: 370,494; xml: 23,474; perl: 3,664; sh: 3,482; ansic: 2,257; sql: 2,133; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 157
file content (378 lines) | stat: -rw-r--r-- 9,479 bytes parent folder | download | duplicates (16)
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/inputcontroller/qgs2dgamepadcontroller.h                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







// this is needed for the "convert to subclass" code below to compile
%ModuleHeaderCode
#include "qgs2dgamepadcontroller.h"
%End



class QgsGamepad2DMapController : QgsAbstract2DMapController
{
%Docstring(signature="appended")
Represents a gamepad device used for controlling a 2D map.

.. versionadded:: 3.34
%End

%TypeHeaderCode
#include "qgs2dgamepadcontroller.h"
%End
%ConvertToSubClassCode
    if ( qobject_cast<QgsGamepad2DMapController *>( sipCpp ) )

      sipType = sipType_QgsGamepad2DMapController;
    else
      sipType = nullptr;
%End
  public:
    QgsGamepad2DMapController( int gamepadDeviceId, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsGamepad2DMapController, with the specified
``gamepadDeviceId`` and ``parent`` object.
%End

    virtual QgsGamepad2DMapController *clone() const /Factory/;

    virtual QString deviceId() const;



    bool isConnected() const;
%Docstring
Returns ``True`` if the gamepad is connected.
%End

    QString name() const;
%Docstring
Returns the reported name of the gamepad if one is available.
%End

    double axisLeftX() const;
%Docstring
Returns the value of the left thumbstick's X axis. The axis values range
from -1.0 to 1.0.
%End

    double axisLeftY() const;
%Docstring
Returns the value of the left thumbstick's Y axis. The axis values range
from -1.0 to 1.0.
%End

    double axisRightX() const;
%Docstring
Returns the value of the right thumbstick's X axis. The axis values
range from -1.0 to 1.0.
%End

    double axisRightY() const;
%Docstring
Returns the value of the right thumbstick's Y axis. The axis values
range from -1.0 to 1.0.
%End

    bool buttonA() const;
%Docstring
Returns the state of the A button. The value is ``True`` when pressed,
and ``False`` when not pressed.
%End

    bool buttonB() const;
%Docstring
Returns the state of the B button. The value is ``True`` when pressed,
and ``False`` when not pressed.
%End

    bool buttonX() const;
%Docstring
Returns the state of the X button. The value is ``True`` when pressed,
and ``False`` when not pressed.
%End

    bool buttonY() const;
%Docstring
Returns the state of the Y button. The value is ``True`` when pressed,
and ``False`` when not pressed.
%End

    bool buttonL1() const;
%Docstring
Returns the state of the left shoulder button. The value is ``True``
when pressed, and ``False`` when not pressed.
%End

    bool buttonR1() const;
%Docstring
Returns the state of the right shoulder button. The value is ``True``
when pressed, and ``False`` when not pressed.
%End

    double buttonL2() const;
%Docstring
Returns the value of the left trigger button. This trigger value ranges
from 0.0 when not pressed to 1.0 when pressed completely.
%End

    double buttonR2() const;
%Docstring
Returns the value of the right trigger button. This trigger value ranges
from 0.0 when not pressed to 1.0 when pressed completely.
%End

    bool buttonSelect() const;
%Docstring
Returns the state of the select button. The value is ``True`` when
pressed, and ``False`` when not pressed.

This button can sometimes be labeled as the Back button on some
gamepads.
%End

    bool buttonStart() const;
%Docstring
Returns the state of the start button. The value is ``True`` when
pressed, and ``False`` when not pressed.

This button can sometimes be labeled as the Forward button on some
gamepads.
%End

    bool buttonL3() const;
%Docstring
Returns the state of the left stick button. The value is ``True`` when
pressed, and ``False`` when not pressed.

This button is usually triggered by pressing the left joystick itself.
%End

    bool buttonR3() const;
%Docstring
Returns the state of the right stick button. The value is ``True`` when
pressed, and ``False`` when not pressed.

This button is usually triggered by pressing the right joystick itself.
%End

    bool buttonUp() const;
%Docstring
Returns the state of the direction pad up button. The value is ``True``
when pressed, and ``False`` when not pressed.
%End

    bool buttonDown() const;
%Docstring
Returns the state of the direction pad down button. The value is
``True`` when pressed, and ``False`` when not pressed.
%End

    bool buttonLeft() const;
%Docstring
Returns the state of the direction pad left button. The value is
``True`` when pressed, and ``False`` when not pressed.
%End

    bool buttonRight() const;
%Docstring
Returns the state of the direction pad right button. The value is
``True`` when pressed, and ``False`` when not pressed.
%End

    bool buttonCenter() const;
%Docstring
Returns the state of the center button. The value is ``True`` when
pressed, and ``False`` when not pressed.
%End

    bool buttonGuide() const;
%Docstring
Returns the state of the center button. The value is ``True`` when
pressed, and ``False`` when not pressed.

This button is typically the one in the center of the gamepad with a
logo. Not all gamepads have a guide button.
%End

  signals:

    void connectedChanged( bool value );
%Docstring
Emitted when the connection state of the gamepad is changed.
%End

    void axisLeftXChanged( double value );
%Docstring
Emitted when the value of the left thumbstick's X axis is changed.

.. seealso:: :py:func:`axisLeftX`
%End

    void axisLeftYChanged( double value );
%Docstring
Emitted when the value of the left thumbstick's Y axis is changed.

.. seealso:: :py:func:`axisLeftY`
%End

    void axisRightXChanged( double value );
%Docstring
Emitted when the value of the right thumbstick's X axis is changed.

.. seealso:: :py:func:`axisRightX`
%End

    void axisRightYChanged( double value );
%Docstring
Emitted when the value of the right thumbstick's Y axis is changed.

.. seealso:: :py:func:`axisRightY`
%End

    void buttonAChanged( bool value );
%Docstring
Emitted when the state of the A button is changed.

.. seealso:: :py:func:`buttonA`
%End

    void buttonBChanged( bool value );
%Docstring
Emitted when the state of the B button is changed.

.. seealso:: :py:func:`buttonB`
%End

    void buttonXChanged( bool value );
%Docstring
Emitted when the state of the X button is changed.

.. seealso:: :py:func:`buttonX`
%End

    void buttonYChanged( bool value );
%Docstring
Emitted when the state of the Y button is changed.

.. seealso:: :py:func:`buttonY`
%End

    void buttonL1Changed( bool value );
%Docstring
Emitted when the state of the left shoulder button is changed.

.. seealso:: :py:func:`buttonL1`
%End

    void buttonR1Changed( bool value );
%Docstring
Emitted when the state of the right shoulder button is changed.

.. seealso:: :py:func:`buttonR1`
%End

    void buttonL2Changed( double value );
%Docstring
Emitted when the state of the left trigger button is changed.

.. seealso:: :py:func:`buttonL2`
%End

    void buttonR2Changed( double value );
%Docstring
Emitted when the state of the right trigger button is changed.

.. seealso:: :py:func:`buttonR2`
%End

    void buttonSelectChanged( bool value );
%Docstring
Emitted when the state of the select button is changed.

.. seealso:: :py:func:`buttonSelect`
%End

    void buttonStartChanged( bool value );
%Docstring
Emitted when the state of the start button is changed.

.. seealso:: :py:func:`buttonStart`
%End

    void buttonL3Changed( bool value );
%Docstring
Emitted when the state of the left stick button is changed.

.. seealso:: :py:func:`buttonL3`
%End

    void buttonR3Changed( bool value );
%Docstring
Emitted when the state of the right stick button is changed.

.. seealso:: :py:func:`buttonR3`
%End

    void buttonUpChanged( bool value );
%Docstring
Emitted when the state of the direction pad up button is changed.

.. seealso:: :py:func:`buttonUp`
%End

    void buttonDownChanged( bool value );
%Docstring
Emitted when the state of the direction pad down button is changed.

.. seealso:: :py:func:`buttonDown`
%End

    void buttonLeftChanged( bool value );
%Docstring
Emitted when the state of the direction pad left button is changed.

.. seealso:: :py:func:`buttonLeft`
%End

    void buttonRightChanged( bool value );
%Docstring
Emitted when the state of the direction pad right button is changed.

.. seealso:: :py:func:`buttonRight`
%End

    void buttonCenterChanged( bool value );
%Docstring
Emitted when the state of the center button is changed.

.. seealso:: :py:func:`buttonCenter`
%End

    void buttonGuideChanged( bool value );
%Docstring
Emitted when the state of the guide button is changed.

.. seealso:: :py:func:`buttonCenter`
%End

};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/inputcontroller/qgs2dgamepadcontroller.h                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/