wxPython/src/_joystick.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _joystick.i
   3 // Purpose:     SWIG interface stuff for wxJoystick
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     18-June-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 %{
  20 #include <wx/joystick.h>
  21 %}
  22
  23 //---------------------------------------------------------------------------
  24
  25
  26
  27 // Which joystick? Same as Windows ids so no conversion necessary.
  28 enum
  29 {
  30     wxJOYSTICK1,
  31     wxJOYSTICK2
  32 };
  33
  34 // Which button is down?
  35 enum
  36 {
  37     wxJOY_BUTTON_ANY,
  38     wxJOY_BUTTON1,
  39     wxJOY_BUTTON2,
  40     wxJOY_BUTTON3,
  41     wxJOY_BUTTON4,
  42 };
  43
  44
  45 %{
  46 #if !wxUSE_JOYSTICK && !defined(__WXMSW__)
  47 // A C++ stub class for wxJoystick for platforms that don't have it.
  48 class wxJoystick : public wxObject {
  49 public:
  50     wxJoystick(int joystick = wxJOYSTICK1) {
  51         bool blocked = wxPyBeginBlockThreads();
  52         PyErr_SetString(PyExc_NotImplementedError,
  53                         "wxJoystick is not available on this platform.");
  54         wxPyEndBlockThreads(blocked);
  55     }
  56     wxPoint GetPosition() { return wxPoint(-1,-1); }
  57     int GetZPosition() { return -1; }
  58     int GetButtonState() { return -1; }
  59     int GetPOVPosition() { return -1; }
  60     int GetPOVCTSPosition() { return -1; }
  61     int GetRudderPosition() { return -1; }
  62     int GetUPosition() { return -1; }
  63     int GetVPosition() { return -1; }
  64     int GetMovementThreshold() { return -1; }
  65     void SetMovementThreshold(int threshold) {}
  66
  67     bool IsOk(void) { return False; }
  68     int GetNumberJoysticks() { return -1; }
  69     int GetManufacturerId() { return -1; }
  70     int GetProductId() { return -1; }
  71     wxString GetProductName() { return wxEmptyString; }
  72     int GetXMin() { return -1; }
  73     int GetYMin() { return -1; }
  74     int GetZMin() { return -1; }
  75     int GetXMax() { return -1; }
  76     int GetYMax() { return -1; }
  77     int GetZMax() { return -1; }
  78     int GetNumberButtons() { return -1; }
  79     int GetNumberAxes() { return -1; }
  80     int GetMaxButtons() { return -1; }
  81     int GetMaxAxes() { return -1; }
  82     int GetPollingMin() { return -1; }
  83     int GetPollingMax() { return -1; }
  84     int GetRudderMin() { return -1; }
  85     int GetRudderMax() { return -1; }
  86     int GetUMin() { return -1; }
  87     int GetUMax() { return -1; }
  88     int GetVMin() { return -1; }
  89     int GetVMax() { return -1; }
  90
  91     bool HasRudder() { return False; }
  92     bool HasZ() { return False; }
  93     bool HasU() { return False; }
  94     bool HasV() { return False; }
  95     bool HasPOV() { return False; }
  96     bool HasPOV4Dir() { return False; }
  97     bool HasPOVCTS() { return False; }
  98
  99     bool SetCapture(wxWindow* win, int pollingFreq = 0) { return False; }
 100     bool ReleaseCapture() { return False; }
 101 };
 102 #endif
 103 %}
 104
 105
 106 MustHaveApp(wxJoystick);
 107
 108 class wxJoystick /* : public wxObject */
 109 {
 110 public:
 111     wxJoystick(int joystick = wxJOYSTICK1);
 112     ~wxJoystick();
 113
 114     wxPoint GetPosition();
 115     int GetZPosition();
 116     int GetButtonState();
 117     int GetPOVPosition();
 118     int GetPOVCTSPosition();
 119     int GetRudderPosition();
 120     int GetUPosition();
 121     int GetVPosition();
 122     int GetMovementThreshold();
 123     void SetMovementThreshold(int threshold) ;
 124
 125     bool IsOk(void);
 126     int GetNumberJoysticks();
 127     int GetManufacturerId();
 128     int GetProductId();
 129     wxString GetProductName();
 130     int GetXMin();
 131     int GetYMin();
 132     int GetZMin();
 133     int GetXMax();
 134     int GetYMax();
 135     int GetZMax();
 136     int GetNumberButtons();
 137     int GetNumberAxes();
 138     int GetMaxButtons();
 139     int GetMaxAxes();
 140     int GetPollingMin();
 141     int GetPollingMax();
 142     int GetRudderMin();
 143     int GetRudderMax();
 144     int GetUMin();
 145     int GetUMax();
 146     int GetVMin();
 147     int GetVMax();
 148
 149     bool HasRudder();
 150     bool HasZ();
 151     bool HasU();
 152     bool HasV();
 153     bool HasPOV();
 154     bool HasPOV4Dir();
 155     bool HasPOVCTS();
 156
 157     bool SetCapture(wxWindow* win, int pollingFreq = 0);
 158     bool ReleaseCapture();
 159
 160     %pythoncode { def __nonzero__(self): return self.IsOk() }
 161 };
 162
 163
 164 //---------------------------------------------------------------------------
 165
 166 %constant wxEventType wxEVT_JOY_BUTTON_DOWN;
 167 %constant wxEventType wxEVT_JOY_BUTTON_UP;
 168 %constant wxEventType wxEVT_JOY_MOVE;
 169 %constant wxEventType wxEVT_JOY_ZMOVE;
 170
 171
 172 class wxJoystickEvent : public wxEvent
 173 {
 174 public:
 175     wxPoint   m_pos;
 176     int       m_zPosition;
 177     int       m_buttonChange;   // Which button changed?
 178     int       m_buttonState;    // Which buttons are down?
 179     int       m_joyStick;       // Which joystick?
 180
 181     wxJoystickEvent(wxEventType type = wxEVT_NULL,
 182                     int state = 0,
 183                     int joystick = wxJOYSTICK1,
 184                     int change = 0);
 185
 186     wxPoint GetPosition() const;
 187     int GetZPosition() const;
 188     int GetButtonState() const;
 189     int GetButtonChange() const;
 190     int GetJoystick() const;
 191
 192     void SetJoystick(int stick);
 193     void SetButtonState(int state);
 194     void SetButtonChange(int change);
 195     void SetPosition(const wxPoint& pos);
 196     void SetZPosition(int zPos);
 197
 198     // Was it a button event? (*doesn't* mean: is any button *down*?)
 199     bool IsButton() const;
 200
 201     // Was it a move event?
 202     bool IsMove() const;
 203
 204     // Was it a zmove event?
 205     bool IsZMove() const;
 206
 207     // Was it a down event from button 1, 2, 3, 4 or any?
 208     bool ButtonDown(int but = wxJOY_BUTTON_ANY) const;
 209
 210     // Was it a up event from button 1, 2, 3 or any?
 211     bool ButtonUp(int but = wxJOY_BUTTON_ANY) const;
 212
 213     // Was the given button 1,2,3,4 or any in Down state?
 214     bool ButtonIsDown(int but =  wxJOY_BUTTON_ANY) const;
 215 };
 216
 217
 218 %pythoncode {
 219 EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN )
 220 EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP )
 221 EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE )
 222 EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE )
 223
 224 EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN,
 225                                         wxEVT_JOY_BUTTON_UP,
 226                                         wxEVT_JOY_MOVE,
 227                                         wxEVT_JOY_ZMOVE,
 228                                         ])
 229
 230 }
 231
 232 //---------------------------------------------------------------------------