.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxJoystick 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxJoystick \- 
.SH DESCRIPTION

  


   wxJoystick allows an application to control one or more joysticks.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/joystick.h
.SH MEMBERS

  
.SS  wxJoystick (int joystick = wxJOYSTICK1)

     


      Constructor.
      
       joystick
      
      may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick controller
      of interest.
     
    
   
  
.SS  ~wxJoystick ()

     


      Destroys the wxJoystick object.
     
    
   
  
.SS int GetButtonState ()

     


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

     


      Returns the manufacturer id.
     
    
   
  
.SS int GetMovementThreshold ()

     


      Returns the movement threshold, the number of steps outside which the
      joystick is deemed to have moved.
     
    
   
  
.SS int GetNumberAxes ()

     


      Returns the number of axes for this joystick.
     
    
   
  
.SS int GetNumberButtons ()

     


      Returns the number of buttons for this joystick.
     
    
   
  
.SS int GetNumberJoysticks ()

     


      Returns the number of joysticks currently attached to the computer.
     
    
   
  
.SS int GetPollingMax ()

     


      Returns the maximum polling frequency.
     
    
   
  
.SS int GetPollingMin ()

     


      Returns the minimum polling frequency.
     
    
   
  
.SS int GetProductId ()

     


      Returns the product id for the joystick.
     
    
   
  
.SS wxString GetProductName ()

     


      Returns the product name for the joystick.
     
    
   
  
.SS wxPoint GetPosition ()

     


      Returns the x, y position of the joystick.
     
    
   
  
.SS int GetPOVPosition ()

     


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

     


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

     


      Returns the maximum rudder position.
     
    
   
  
.SS int GetRudderMin ()

     


      Returns the minimum rudder position.
     
    
   
  
.SS int GetRudderPosition ()

     


      Returns the rudder position.
     
    
   
  
.SS int GetUMax ()

     


      Returns the maximum U position.
     
    
   
  
.SS int GetUMin ()

     


      Returns the minimum U position.
     
    
   
  
.SS int GetUPosition ()

     


      Gets the position of the fifth axis of the joystick, if it exists.
     
    
   
  
.SS int GetVMax ()

     


      Returns the maximum V position.
     
    
   
  
.SS int GetVMin ()

     


      Returns the minimum V position.
     
    
   
  
.SS int GetVPosition ()

     


      Gets the position of the sixth axis of the joystick, if it exists.
     
    
   
  
.SS int GetXMax ()

     


      Returns the maximum x position.
     
    
   
  
.SS int GetXMin ()

     


      Returns the minimum x position.
     
    
   
  
.SS int GetYMax ()

     


      Returns the maximum y position.
     
    
   
  
.SS int GetYMin ()

     


      Returns the minimum y position.
     
    
   
  
.SS int GetZMax ()

     


      Returns the maximum z position.
     
    
   
  
.SS int GetZMin ()

     


      Returns the minimum z position.
     
    
   
  
.SS int GetZPosition ()

     


      Returns the z position of the joystick.
     
    
   
  
.SS bool HasPOV ()

     


      Returns true if the joystick has a point of view control.
     
    
   
  
.SS bool HasPOV4Dir ()

     


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

     


      Returns true if the joystick point-of-view supports continuous degree
      bearings.
     
    
   
  
.SS bool HasRudder ()

     


      Returns true if there is a rudder attached to the computer.
     
    
   
  
.SS bool HasU ()

     


      Returns true if the joystick has a U axis.
     
    
   
  
.SS bool HasV ()

     


      Returns true if the joystick has a V axis.
     
    
   
  
.SS bool HasZ ()

     


      Returns true if the joystick has a Z axis.
     
    
   
  
.SS bool IsOk ()

     


      Returns true if the joystick is functioning.
     
    
   
  
.SS bool ReleaseCapture ()

   
  
.SS bool SetCapture (wxWindow* winint pollingFreq = 0)

   
  
.SS void SetMovementThreshold (int threshold)

     


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

  wxObject
 
  wxJoystickEvent
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.