XBoxController (RoboLibJ

java.lang.Object
- io.github.robolib.module.hid.GenericHID
- - io.github.robolib.module.hid.Joystick
  - - io.github.robolib.module.hid.XBoxController

All Implemented Interfaces:

HIDModule, Module
```
public final class XBoxController
extends Joystick
```
A better Joystick implementation for the XBox Controller.

Author:

noriah

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class XBoxController.MagAxis
- Nested classes/interfaces inherited from class io.github.robolib.module.hid.Joystick
  Joystick.JoystickAxis, Joystick.JoystickButton, Joystick.JSID, Joystick.RumbleSide

Nested Classes
Modifier and Type	Class and Description
`private class`	`XBoxController.MagAxis`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AXIS_MAG_LEFT` Magnitude Left Stick Axis ID.
`static int`	`AXIS_MAG_RIGHT` Magnitude Right Stick Axis ID.
`static int`	`AXIS_TRIGGER_LEFT` Left Trigger Axis ID.
`static int`	`AXIS_TRIGGER_RIGHT` Right Trigger Axis ID.
`static int`	`AXIS_X_LEFT` Left X Axis ID.
`static int`	`AXIS_X_RIGHT` Right X Axis ID.
`static int`	`AXIS_Y_LEFT` Left Y Axis ID.
`static int`	`AXIS_Y_RIGHT` Right Y Axis ID.
`static int`	`BTN_A` A Button ID.
`static int`	`BTN_AXIS_TRIGGER_LEFT` Left Trigger Axis Button ID.
`static int`	`BTN_AXIS_TRIGGER_RIGHT` Right Trigger Axis Button ID.
`static int`	`BTN_AXIS_X_LEFT` Left X Axis Button ID.
`static int`	`BTN_AXIS_X_RIGHT` Right X Axis Button ID.
`static int`	`BTN_AXIS_Y_LEFT` Left Y Axis Button ID.
`static int`	`BTN_AXIS_Y_RIGHT` Right Y Axis Button ID.
`static int`	`BTN_B` B Button ID.
`static int`	`BTN_SELECT` Back Button ID.
`static int`	`BTN_SHOULDER_LEFT` Left Shoulder Button ID.
`static int`	`BTN_SHOULDER_RIGHT` Right Shoulder Button ID.
`static int`	`BTN_START` Start Button ID.
`static int`	`BTN_STICK_LEFT` Left Stick Button ID.
`static int`	`BTN_STICK_RIGHT` Right Stick Button ID.
`static int`	`BTN_X` X Button ID.
`static int`	`BTN_Y` Y Button ID.
`static int`	`POV_HAT` Hat X Axis ID.

Fields inherited from class io.github.robolib.module.hid.Joystick
kNumJoysticks

Fields inherited from class io.github.robolib.module.hid.GenericHID
m_axes, m_btns, m_numAxes, m_numBtns

Constructor Summary

Constructors
Constructor and Description

XBoxController(Joystick.JSID port)
A better Joystick implementation for the XBox Controller.

Constructors
Constructor and Description
`XBoxController(Joystick.JSID port)` A better Joystick implementation for the XBox Controller.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIDAxis`	`getAxisLeftMagnitude()` Get the Left Stick Magnitude Axis.
`HIDAxis`	`getAxisLeftTrigger()` Get the Left Trigger Axis.
`double`	`getAxisLeftTriggerValue()` Get the Left Trigger Axis value.
`double`	`getAxisLeftValue()` Get the Left Stick Magnitude Axis value.
`HIDAxis`	`getAxisLeftX()` Get the Left X Axis.
`double`	`getAxisLeftXValue()` Get the Left X Axis value.
`HIDAxis`	`getAxisLeftY()` Get the Left Y Axis.
`double`	`getAxisLeftYValue()` Get the Left Y Axis value.
`HIDAxis`	`getAxisRightMagnitude()` Get the Right Stick Magnitude Axis.
`HIDAxis`	`getAxisRightTrigger()` Get the Right Trigger Axis.
`double`	`getAxisRightTriggerValue()` Get the Right Trigger Axis value.
`double`	`getAxisRightValue()` Get the Right Stick Magnitude Axis value.
`HIDAxis`	`getAxisRightX()` Get the Right X Axis.
`double`	`getAxisRightXValue()` Get the Right X Axis value.
`HIDAxis`	`getAxisRightY()` Get the Right Y Axis.
`double`	`getAxisRightYValue()` Get the Right Y Axis value.
`HIDButton`	`getButtonA()` Get the A Button.
`boolean`	`getButtonAValue()` Get the A Button value.
`HIDButton`	`getButtonB()` Get the B Button.
`boolean`	`getButtonBValue()` Get the B Button value.
`HIDButton`	`getButtonLeftShoulder()` Get the Left Shoulder Button.
`boolean`	`getButtonLeftShoulderValue()` Get the Left Shoulder Button value.
`HIDButton`	`getButtonLeftStick()` Get the Left Stick Button.
`boolean`	`getButtonLeftStickValue()` Get the Left Stick Button value.
`HIDButton`	`getButtonRightShoulder()` Get the Right Shoulder Button.
`boolean`	`getButtonRightShoulderValue()` Get the Right Shoulder Button value.
`HIDButton`	`getButtonRightStick()` Get the Right Stick Button.
`boolean`	`getButtonRightStickValue()` Get the Right Stick Button value.
`HIDButton`	`getButtonSelect()` Get the Select Button.
`boolean`	`getButtonSelectValue()` Get the Select Button value.
`HIDButton`	`getButtonStart()` Get the Start Button.
`boolean`	`getButtonStartValue()` Get the Start Button value.
`HIDButton`	`getButtonX()` Get the X Button.
`boolean`	`getButtonXValue()` Get the X Button value.
`HIDButton`	`getButtonY()` Get the Y Button.
`boolean`	`getButtonYValue()` Get the Y Button value.
`int`	`getHat()` Get the D-Pad/Hat POV Vale.
`double`	`getLeftDirectionDegrees()` Get the direction of the vector formed by the left stick and its origin in degrees uses acos(-1) to represent Pi due to absence of readily accessable Pi constant in C++
`double`	`getLeftDirectionRadians()` Get the direction of the vector formed by the left stick and its origin in radians
`double`	`getRightDirectionDegrees()` Get the direction of the vector formed by the right stick and its origin in degrees uses acos(-1) to represent Pi due to absence of readily accessable Pi constant in C++
`double`	`getRightDirectionRadians()` Get the direction of the vector formed by the right stick and its origin in radians

Methods inherited from class io.github.robolib.module.hid.Joystick
checkStick, complainJoystickMissing, disableModule, enableModule, getModuleEnabled, getPOV, getStick, getStickAxis, getStickButton, getStickPort, getStickPOV, setJoystickData, setOutput, setOutputs, setRumble

Methods inherited from class io.github.robolib.module.hid.GenericHID
addAxisButton, addButton, checkAxis, checkButton, getAxis, getButton, getRawAxis, getRawButton, setAxis, setAxisDeadband, setAxisInverted, setButton

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

- Field Detail
  - AXIS_X_LEFT
```
public static final int AXIS_X_LEFT
```
    Left X Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_Y_LEFT
```
public static final int AXIS_Y_LEFT
```
    Left Y Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_TRIGGER_LEFT
```
public static final int AXIS_TRIGGER_LEFT
```
    Left Trigger Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_TRIGGER_RIGHT
```
public static final int AXIS_TRIGGER_RIGHT
```
    Right Trigger Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_X_RIGHT
```
public static final int AXIS_X_RIGHT
```
    Right X Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_Y_RIGHT
```
public static final int AXIS_Y_RIGHT
```
    Right Y Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_MAG_LEFT
```
public static final int AXIS_MAG_LEFT
```
    Magnitude Left Stick Axis ID.
    
    See Also:
    
    Constant Field Values
  - AXIS_MAG_RIGHT
```
public static final int AXIS_MAG_RIGHT
```
    Magnitude Right Stick Axis ID.
    
    See Also:
    
    Constant Field Values
  - POV_HAT
```
public static final int POV_HAT
```
    Hat X Axis ID.
    
    See Also:
    
    Constant Field Values
  - BTN_A
```
public static final int BTN_A
```
    A Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_B
```
public static final int BTN_B
```
    B Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_X
```
public static final int BTN_X
```
    X Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_Y
```
public static final int BTN_Y
```
    Y Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_SHOULDER_LEFT
```
public static final int BTN_SHOULDER_LEFT
```
    Left Shoulder Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_SHOULDER_RIGHT
```
public static final int BTN_SHOULDER_RIGHT
```
    Right Shoulder Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_START
```
public static final int BTN_START
```
    Start Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_SELECT
```
public static final int BTN_SELECT
```
    Back Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_STICK_LEFT
```
public static final int BTN_STICK_LEFT
```
    Left Stick Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_STICK_RIGHT
```
public static final int BTN_STICK_RIGHT
```
    Right Stick Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_X_LEFT
```
public static final int BTN_AXIS_X_LEFT
```
    Left X Axis Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_Y_LEFT
```
public static final int BTN_AXIS_Y_LEFT
```
    Left Y Axis Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_TRIGGER_LEFT
```
public static final int BTN_AXIS_TRIGGER_LEFT
```
    Left Trigger Axis Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_TRIGGER_RIGHT
```
public static final int BTN_AXIS_TRIGGER_RIGHT
```
    Right Trigger Axis Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_X_RIGHT
```
public static final int BTN_AXIS_X_RIGHT
```
    Right X Axis Button ID.
    
    See Also:
    
    Constant Field Values
  - BTN_AXIS_Y_RIGHT
```
public static final int BTN_AXIS_Y_RIGHT
```
    Right Y Axis Button ID.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XBoxController
```
public XBoxController(Joystick.JSID port)
```
    A better Joystick implementation for the XBox Controller.
    
    Parameters:
    
    port - The Joystick Number this XBoxController is on.
- Method Detail
  - getAxisLeftX
```
public HIDAxis getAxisLeftX()
```
    Get the Left X Axis.
    
    Returns:
    
    the left X axis
  - getAxisLeftY
```
public HIDAxis getAxisLeftY()
```
    Get the Left Y Axis.
    
    Returns:
    
    the right Y axis
  - getAxisLeftTrigger
```
public HIDAxis getAxisLeftTrigger()
```
    Get the Left Trigger Axis.
    
    Returns:
    
    the trigger axis
  - getAxisRightTrigger
```
public HIDAxis getAxisRightTrigger()
```
    Get the Right Trigger Axis.
    
    Returns:
    
    the trigger axis
  - getAxisRightX
```
public HIDAxis getAxisRightX()
```
    Get the Right X Axis.
    
    Returns:
    
    the right x axis
  - getAxisRightY
```
public HIDAxis getAxisRightY()
```
    Get the Right Y Axis.
    
    Returns:
    
    the right Y axis
  - getAxisLeftMagnitude
```
public HIDAxis getAxisLeftMagnitude()
```
    Get the Left Stick Magnitude Axis.
    
    Returns:
    
    the left stick Magnitude axis.
  - getAxisRightMagnitude
```
public HIDAxis getAxisRightMagnitude()
```
    Get the Right Stick Magnitude Axis.
    
    Returns:
    
    the right stick Magnitude axis.
  - getButtonA
```
public HIDButton getButtonA()
```
    Get the A Button.
    
    Returns:
    
    the A button
  - getButtonB
```
public HIDButton getButtonB()
```
    Get the B Button.
    
    Returns:
    
    the B button
  - getButtonX
```
public HIDButton getButtonX()
```
    Get the X Button.
    
    Returns:
    
    the X button
  - getButtonY
```
public HIDButton getButtonY()
```
    Get the Y Button.
    
    Returns:
    
    the Y button
  - getButtonLeftShoulder
```
public HIDButton getButtonLeftShoulder()
```
    Get the Left Shoulder Button.
    
    Returns:
    
    the Left Shoulder button
  - getButtonRightShoulder
```
public HIDButton getButtonRightShoulder()
```
    Get the Right Shoulder Button.
    
    Returns:
    
    the Right Shoulder button
  - getButtonStart
```
public HIDButton getButtonStart()
```
    Get the Start Button.
    
    Returns:
    
    the Start button
  - getButtonSelect
```
public HIDButton getButtonSelect()
```
    Get the Select Button.
    
    Returns:
    
    the Select button
  - getButtonLeftStick
```
public HIDButton getButtonLeftStick()
```
    Get the Left Stick Button.
    
    Returns:
    
    the Left Stick button
  - getButtonRightStick
```
public HIDButton getButtonRightStick()
```
    Get the Right Stick Button.
    
    Returns:
    
    the Right Stick button
  - getAxisLeftXValue
```
public double getAxisLeftXValue()
```
    Get the Left X Axis value.
    
    Returns:
    
    the left X axis value
  - getAxisLeftYValue
```
public double getAxisLeftYValue()
```
    Get the Left Y Axis value.
    
    Returns:
    
    the right Y axis value
  - getAxisLeftTriggerValue
```
public double getAxisLeftTriggerValue()
```
    Get the Left Trigger Axis value.
    
    Returns:
    
    the trigger axis value
  - getAxisRightTriggerValue
```
public double getAxisRightTriggerValue()
```
    Get the Right Trigger Axis value.
    
    Returns:
    
    the trigger axis value
  - getAxisRightXValue
```
public double getAxisRightXValue()
```
    Get the Right X Axis value.
    
    Returns:
    
    the right x axis value
  - getAxisRightYValue
```
public double getAxisRightYValue()
```
    Get the Right Y Axis value.
    
    Returns:
    
    the right Y axis value
  - getAxisLeftValue
```
public double getAxisLeftValue()
```
    Get the Left Stick Magnitude Axis value.
    
    Returns:
    
    the left stick Magnitude axis value.
  - getAxisRightValue
```
public double getAxisRightValue()
```
    Get the Right Stick Magnitude Axis value.
    
    Returns:
    
    the right stick Magnitude axis value.
  - getHat
```
public int getHat()
```
    Get the D-Pad/Hat POV Vale.
    
    Returns:
    
    the d-pad pov value
  - getButtonAValue
```
public boolean getButtonAValue()
```
    Get the A Button value.
    
    Returns:
    
    the A button value
  - getButtonBValue
```
public boolean getButtonBValue()
```
    Get the B Button value.
    
    Returns:
    
    the B button value
  - getButtonXValue
```
public boolean getButtonXValue()
```
    Get the X Button value.
    
    Returns:
    
    the X button value
  - getButtonYValue
```
public boolean getButtonYValue()
```
    Get the Y Button value.
    
    Returns:
    
    the Y button value
  - getButtonLeftShoulderValue
```
public boolean getButtonLeftShoulderValue()
```
    Get the Left Shoulder Button value.
    
    Returns:
    
    the Left Shoulder button value
  - getButtonRightShoulderValue
```
public boolean getButtonRightShoulderValue()
```
    Get the Right Shoulder Button value.
    
    Returns:
    
    the Right Shoulder button value
  - getButtonStartValue
```
public boolean getButtonStartValue()
```
    Get the Start Button value.
    
    Returns:
    
    the Start button value
  - getButtonSelectValue
```
public boolean getButtonSelectValue()
```
    Get the Select Button value.
    
    Returns:
    
    the Select button value
  - getButtonLeftStickValue
```
public boolean getButtonLeftStickValue()
```
    Get the Left Stick Button value.
    
    Returns:
    
    the Left Stick button value
  - getButtonRightStickValue
```
public boolean getButtonRightStickValue()
```
    Get the Right Stick Button value.
    
    Returns:
    
    the Right Stick button value
  - getLeftDirectionRadians
```
public double getLeftDirectionRadians()
```
    Get the direction of the vector formed by the left stick and its origin in radians
    
    Returns:
    
    The direction of the vector in radians of the left stick
  - getLeftDirectionDegrees
```
public double getLeftDirectionDegrees()
```
    Get the direction of the vector formed by the left stick and its origin in degrees uses acos(-1) to represent Pi due to absence of readily accessable Pi constant in C++
    
    Returns:
    
    The direction of the vector in degrees of the left stick
  - getRightDirectionRadians
```
public double getRightDirectionRadians()
```
    Get the direction of the vector formed by the right stick and its origin in radians
    
    Returns:
    
    The direction of the vector in radians of the right stick
  - getRightDirectionDegrees
```
public double getRightDirectionDegrees()
```
    Get the direction of the vector formed by the right stick and its origin in degrees uses acos(-1) to represent Pi due to absence of readily accessable Pi constant in C++
    
    Returns:
    
    The direction of the vector in degrees of the right stick

Class XBoxController

Nested Class Summary

Nested classes/interfaces inherited from class io.github.robolib.module.hid.Joystick

Field Summary

Fields inherited from class io.github.robolib.module.hid.Joystick

Fields inherited from class io.github.robolib.module.hid.GenericHID

Constructor Summary

Method Summary

Methods inherited from class io.github.robolib.module.hid.Joystick

Methods inherited from class io.github.robolib.module.hid.GenericHID

Methods inherited from class java.lang.Object

Field Detail

AXIS_X_LEFT

AXIS_Y_LEFT

AXIS_TRIGGER_LEFT

AXIS_TRIGGER_RIGHT

AXIS_X_RIGHT

AXIS_Y_RIGHT

AXIS_MAG_LEFT

AXIS_MAG_RIGHT

POV_HAT

BTN_A

BTN_B

BTN_X

BTN_Y

BTN_SHOULDER_LEFT

BTN_SHOULDER_RIGHT

BTN_START

BTN_SELECT

BTN_STICK_LEFT

BTN_STICK_RIGHT

BTN_AXIS_X_LEFT

BTN_AXIS_Y_LEFT

BTN_AXIS_TRIGGER_LEFT

BTN_AXIS_TRIGGER_RIGHT

BTN_AXIS_X_RIGHT

BTN_AXIS_Y_RIGHT

Constructor Detail

XBoxController

Method Detail

getAxisLeftX

getAxisLeftY

getAxisLeftTrigger

getAxisRightTrigger

getAxisRightX

getAxisRightY

getAxisLeftMagnitude

getAxisRightMagnitude

getButtonA

getButtonB

getButtonX

getButtonY

getButtonLeftShoulder

getButtonRightShoulder

getButtonStart

getButtonSelect

getButtonLeftStick

getButtonRightStick

getAxisLeftXValue

getAxisLeftYValue

getAxisLeftTriggerValue

getAxisRightTriggerValue

getAxisRightXValue

getAxisRightYValue

getAxisLeftValue

getAxisRightValue

getHat

getButtonAValue

getButtonBValue

getButtonXValue

getButtonYValue

getButtonLeftShoulderValue

getButtonRightShoulderValue

getButtonStartValue

getButtonSelectValue

getButtonLeftStickValue

getButtonRightStickValue

getLeftDirectionRadians

getLeftDirectionDegrees

getRightDirectionRadians