Joystick (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.joystick.Joystick

All Implemented Interfaces:

JoystickObserver, Runnable
```
public class Joystick
extends Object
implements Runnable, JoystickObserver
```
Interface to joysticks. This should be generalized to other input devices, such as track balls etc.
Responsible for finding any input devices attached. We know about at this writing the Logitech Freedom 2.4 device and the Macally airstick, and have mappings for those devices into command inputs for AVCL.
This implements a singleton pattern. To retrieve a joystick object, use Joystick.getJoystick();
Note that "Controller" is a net.java.games.input object.
To add a new type of joystick: 1) Determine its name, as retrieved by the controller.getName() in jinput 2) add the name to the knownJoystickNames array 3) add a mappings Map object, which matches the button press or joystick tilt axis named to the workbench operation we want to happen; 4) add that mappings object to the stickNameToJoystickEventCommandTypeMappings lookup

Author:

mcgredo

Field Summary

Fields
Modifier and Type	Field and Description
`static Map<String,Map<String,String>>`	`componentToDescriptionMappings` Key is the name of the joystick ("Logitech Freedom 2.4"), value is the mappings hashmap of the user-picked description for the location of the control and control itself
`static Map<String,Map<String,Double>>`	`componentToScalingMappings`
`List<JoystickEventListener>`	`joystickEventListenerList` Holds list of objects that receive joystick events
`static String[]`	`knownJoystickNames` The name, as returned by the controller.getName() method, of the joysticks that we have tested and support
`static String`	`selectedJoystickName` The name of the joystick that has been selected from all the possible joysticks; the first available device that matches a name of the supported joysticks
`static float`	`SIGNIFICANT_JOYSTICK_VALUE` Treat joystick events with values below this as zero
`static Map<String,Map<String,JoystickEvent.CommandType>>`	`stickNameToJoystickEventCommandTypeMappings` Key is the name of the joystick ("Logitech Freedom 2.4"), value is the mappings hashmap for that joystick, which maps jinput-returned events to our AUV events

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(JoystickEventListener newListener)` JoystickObserver interface implementation.
`static Joystick`	`getJoystick()` If a supported joystick is present it returns a joystick object object for that.
`String`	`getName()`
`boolean`	`isFound()`
`static boolean`	`isJoystickPresent()` Returns true if there is a supported joystick present
`static void`	`listControllers()` Debugging.
`static void`	`main(String[] args)`
`void`	`removeAllListeners()` Removes all objects that are listening for joystick events
`void`	`removeListener(JoystickEventListener listener)` JoystickObserver interface implementation. removes an object that is listening for events.
`void`	`run()`
`void`	`setRunning(boolean status)`
`void`	`stopPollingThread()` Causes the joystick polling thread to exit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - knownJoystickNames
```
public static final String[] knownJoystickNames
```
    The name, as returned by the controller.getName() method, of the joysticks that we have tested and support
  - selectedJoystickName
```
public static String selectedJoystickName
```
    The name of the joystick that has been selected from all the possible joysticks; the first available device that matches a name of the supported joysticks
  - stickNameToJoystickEventCommandTypeMappings
```
public static Map<String,Map<String,JoystickEvent.CommandType>> stickNameToJoystickEventCommandTypeMappings
```
    Key is the name of the joystick ("Logitech Freedom 2.4"), value is the mappings hashmap for that joystick, which maps jinput-returned events to our AUV events
  - componentToDescriptionMappings
```
public static Map<String,Map<String,String>> componentToDescriptionMappings
```
    Key is the name of the joystick ("Logitech Freedom 2.4"), value is the mappings hashmap of the user-picked description for the location of the control and control itself
  - componentToScalingMappings
```
public static Map<String,Map<String,Double>> componentToScalingMappings
```
  - joystickEventListenerList
```
public final List<JoystickEventListener> joystickEventListenerList
```
    Holds list of objects that receive joystick events
  - SIGNIFICANT_JOYSTICK_VALUE
```
public static final float SIGNIFICANT_JOYSTICK_VALUE
```
    Treat joystick events with values below this as zero
    
    See Also:
    
    Constant Field Values
- Method Detail
  - main
```
public static void main(String[] args)
```
  - isJoystickPresent
```
public static boolean isJoystickPresent()
```
    Returns true if there is a supported joystick present
    
    Returns:
    
    whether Joystick is connected
  - getJoystick
```
public static Joystick getJoystick()
```
    If a supported joystick is present it returns a joystick object object for that. TODO: doesn't switch joysticks if a joystick is used, unplugged and then switched with another one.
    
    Returns:
    
    active Joystick
  - getName
```
public String getName()
```
    Returns:
    
    name of joystick
  - isFound
```
public boolean isFound()
```
    Returns:
    
    name of joystick
  - listControllers
```
public static void listControllers()
```
    Debugging. List all the USB bus controllers attached to this host. Typically this will include keyboards, mice, and any joysticks.
  - addListener
```
public void addListener(JoystickEventListener newListener)
```
    JoystickObserver interface implementation. Adds an object that will be notified of new controller events. If the object is already present in the list, it is not added again.
    
    Specified by:
    
    addListener in interface JoystickObserver
    
    Parameters:
    
    newListener -
  - removeListener
```
public void removeListener(JoystickEventListener listener)
```
    JoystickObserver interface implementation. removes an object that is listening for events. If the object is missing, there will be no effect.
    
    Specified by:
    
    removeListener in interface JoystickObserver
    
    Parameters:
    
    listener -
  - setRunning
```
public void setRunning(boolean status)
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - removeAllListeners
```
public void removeAllListeners()
```
    Description copied from interface: JoystickObserver
    
    Removes all objects that are listening for joystick events
    
    Specified by:
    
    removeAllListeners in interface JoystickObserver
  - stopPollingThread
```
public void stopPollingThread()
```
    Causes the joystick polling thread to exit
    
    Specified by:
    
    stopPollingThread in interface JoystickObserver

Class Joystick

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

knownJoystickNames

selectedJoystickName

stickNameToJoystickEventCommandTypeMappings

componentToDescriptionMappings

componentToScalingMappings

joystickEventListenerList

SIGNIFICANT_JOYSTICK_VALUE

Method Detail

main

isJoystickPresent

getJoystick

getName

isFound

listControllers

addListener

removeListener

setRunning

run

removeAllListeners

stopPollingThread