## wxJoystick

wxJoystick allows an application to control one or more joysticks.

Derived from

wxObject

Include files

<wx/joystick.h>

See also

wxJoystickEvent

Members

wxJoystick::wxJoystick
wxJoystick::~wxJoystick
wxJoystick::GetButtonState
wxJoystick::GetManufacturerId
wxJoystick::GetMovementThreshold
wxJoystick::GetNumberAxes
wxJoystick::GetNumberButtons
wxJoystick::GetNumberJoysticks
wxJoystick::GetPollingMax
wxJoystick::GetPollingMin
wxJoystick::GetProductId
wxJoystick::GetProductName
wxJoystick::GetPosition
wxJoystick::GetPOVPosition
wxJoystick::GetPOVCTSPosition
wxJoystick::GetRudderMax
wxJoystick::GetRudderMin
wxJoystick::GetRudderPosition
wxJoystick::GetUMax
wxJoystick::GetUMin
wxJoystick::GetUPosition
wxJoystick::GetVMax
wxJoystick::GetVMin
wxJoystick::GetVPosition
wxJoystick::GetXMax
wxJoystick::GetXMin
wxJoystick::GetYMax
wxJoystick::GetYMin
wxJoystick::GetZMax
wxJoystick::GetZMin
wxJoystick::GetZPosition
wxJoystick::HasPOV
wxJoystick::HasPOV4Dir
wxJoystick::HasPOVCTS
wxJoystick::HasRudder
wxJoystick::HasU
wxJoystick::HasV
wxJoystick::HasZ
wxJoystick::IsOk
wxJoystick::ReleaseCapture
wxJoystick::SetCapture
wxJoystick::SetMovementThreshold

### wxJoystick::wxJoystick

wxJoystick(int joystick = wxJOYSTICK1)

Constructor. joystick may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick controller of interest.

### wxJoystick::~wxJoystick

~wxJoystick()

Destroys the wxJoystick object.

### wxJoystick::GetButtonState

int GetButtonState() const

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.

### wxJoystick::GetManufacturerId

int GetManufacturerId() const

Returns the manufacturer id.

### wxJoystick::GetMovementThreshold

int GetMovementThreshold() const

Returns the movement threshold, the number of steps outside which the joystick is deemed to have moved.

### wxJoystick::GetNumberAxes

int GetNumberAxes() const

Returns the number of axes for this joystick.

### wxJoystick::GetNumberButtons

int GetNumberButtons() const

Returns the number of buttons for this joystick.

### wxJoystick::GetNumberJoysticks

int GetNumberJoysticks() const

Returns the number of joysticks currently attached to the computer.

### wxJoystick::GetPollingMax

int GetPollingMax() const

Returns the maximum polling frequency.

### wxJoystick::GetPollingMin

int GetPollingMin() const

Returns the minimum polling frequency.

### wxJoystick::GetProductId

int GetProductId() const

Returns the product id for the joystick.

### wxJoystick::GetProductName

wxString GetProductName() const

Returns the product name for the joystick.

### wxJoystick::GetPosition

wxPoint GetPosition() const

Returns the x, y position of the joystick.

### wxJoystick::GetPOVPosition

int GetPOVPosition() 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.

### wxJoystick::GetPOVCTSPosition

int GetPOVCTSPosition() const

Returns the point-of-view position, expressed in continuous, one-hundredth of a degree units. Returns -1 on error.

### wxJoystick::GetRudderMax

int GetRudderMax() const

Returns the maximum rudder position.

### wxJoystick::GetRudderMin

int GetRudderMin() const

Returns the minimum rudder position.

### wxJoystick::GetRudderPosition

int GetRudderPosition() const

Returns the rudder position.

### wxJoystick::GetUMax

int GetUMax() const

Returns the maximum U position.

### wxJoystick::GetUMin

int GetUMin() const

Returns the minimum U position.

### wxJoystick::GetUPosition

int GetUPosition() const

Gets the position of the fifth axis of the joystick, if it exists.

### wxJoystick::GetVMax

int GetVMax() const

Returns the maximum V position.

### wxJoystick::GetVMin

int GetVMin() const

Returns the minimum V position.

### wxJoystick::GetVPosition

int GetVPosition() const

Gets the position of the sixth axis of the joystick, if it exists.

### wxJoystick::GetXMax

int GetXMax() const

Returns the maximum x position.

### wxJoystick::GetXMin

int GetXMin() const

Returns the minimum x position.

### wxJoystick::GetYMax

int GetYMax() const

Returns the maximum y position.

### wxJoystick::GetYMin

int GetYMin() const

Returns the minimum y position.

### wxJoystick::GetZMax

int GetZMax() const

Returns the maximum z position.

### wxJoystick::GetZMin

int GetXMin() const

Returns the minimum z position.

### wxJoystick::GetZPosition

int GetZPosition() const

Returns the z position of the joystick.

### wxJoystick::HasPOV

bool HasPOV() const

Returns TRUE if the joystick has a point of view control.

### wxJoystick::HasPOV4Dir

bool HasPOV4Dir() const

Returns TRUE if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right).

### wxJoystick::HasPOVCTS

bool HasPOVCTS() const

Returns TRUE if the joystick point-of-view supports continuous degree bearings.

### wxJoystick::HasRudder

bool HasRudder() const

Returns TRUE if there is a rudder attached to the computer.

### wxJoystick::HasU

bool HasU() const

Returns TRUE if the joystick has a U axis.

### wxJoystick::HasV

bool HasV() const

Returns TRUE if the joystick has a V axis.

### wxJoystick::HasZ

bool HasZ() const

Returns TRUE if the joystick has a Z axis.

### wxJoystick::IsOk

bool IsOk() const

Returns TRUE if the joystick is functioning.

### wxJoystick::ReleaseCapture

bool ReleaseCapture()

Releases the capture set by SetCapture.

Return value

TRUE if the capture release succeeded.

See also

wxJoystick::SetCapture, wxJoystickEvent

### wxJoystick::SetCapture

bool SetCapture(wxWindow* win, int pollingFreq = 0)

Sets the capture to direct joystick events to win.

Parameters

win

The window that will receive joystick events.

pollingFreq

If zero, movement events are sent when above the threshold. If greater than zero, events are received every pollingFreq milliseconds.

Return value

TRUE if the capture succeeded.

See also

wxJoystick::ReleaseCapture, wxJoystickEvent

### wxJoystick::SetMovementThreshold

void SetMovementThreshold(int threshold)

Sets the movement threshold, the number of steps outside which the joystick is deemed to have moved.