ch.aplu.xboxcontroller

Class XboxController

java.lang.Object

ch.aplu.xboxcontroller.XboxController

public class XboxController
extends java.lang.Object

Class to handle the Microsoft Xbox Game Controller (wired or wireless) in a fully event triggered manner. A native high priority thread polls the state of the controller and feeds an FIFO event queue. This queue is polled by a Java thread that generates callback notifications whenever the state changes. Both polling threads are fully hidden to the user of the package who get callback notifications whenever the state of the controller changes.

The native code executes in a Windows DLL created with the JAW (Java API Wrapper) framework.

Constructor Summary

Constructors

Constructor and Description
XboxController() Same as XboxController(dll, 1, 50, 50).
XboxController(int playerNb) Same as XboxController(dll, int playerNb, 50, 50).
XboxController(int controllerPollPeriod, int queuePollPeriod) Same as XboxController(dll, 1, controllerPollPeriod, queuePollPeriod).
XboxController(java.lang.String dll, int playerNb, int controllerPollPeriod, int queuePollPeriod) Creates a XboxController instance using the given native Windows DLL and tries to establish a connection to the controller with the given player number.

Method Summary

Methods

Modifier and Type	Method and Description
void	addXboxControllerListener(XboxControllerListener xboxControllerListener) Registers the given XboxControllerListener and starts polling the event queue.
static java.lang.String	getVersion() Returns version information.
boolean	isConnected() Returns true if the last native polling call to the controller was successful.
void	release() Release native resources.
void	setDebug(boolean on) Displays debug information when the native thread sends data to the FIFO queue and when the Java thread receives it.
void	setLeftThumbDeadZone(double zone) Sets the dead zone for the left thumb.
void	setLeftTriggerDeadZone(double zone) Sets the dead zone for LeftTrigger.
void	setRightThumbDeadZone(double zone) Sets the dead zone for the right thumb.
void	setRightTriggerDeadZone(double zone) Sets the dead zone for RightTrigger.
void	vibrate(int leftVal, int rightVal) Starts vibration with given left und right intensity.
void	vibrate(int leftVal, int rightVal, int duration) Vibrates with given left und right intensity for the given duration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XboxController

public XboxController()

Same as XboxController(dll, 1, 50, 50). The DLL xboxcontroller.dll or xboxcontroller64.dll is searched in the Windows path (depending on the OS version).

XboxController

public XboxController(int controllerPollPeriod,
              int queuePollPeriod)

Same as XboxController(dll, 1, controllerPollPeriod, queuePollPeriod). The DLL xboxcontroller.dll or xboxcontroller64.dll is searched in the Windows path (depending on the OS version).

XboxController

public XboxController(int playerNb)

Same as XboxController(dll, int playerNb, 50, 50). The DLL xboxcontroller.dll or xboxcontroller64.dll is searched in the Windows path (depending on the OS version).

XboxController

public XboxController(java.lang.String dll,
              int playerNb,
              int controllerPollPeriod,
              int queuePollPeriod)

Creates a XboxController instance using the given native Windows DLL and tries to establish a connection to the controller with the given player number.

Parameters:

dll - the fully qualified path to the native DLL. If the extension .DLL is missing, the DLL is searched in the Windows path.

playerNb - the number of the player 1..4

controllerPollPeriod - the period (in ms) of the native timer that polls the state of the controller

queuePollPeriod - the period (in ms) of the Java timer that polls the message queue

Method Detail

release

public void release()

Release native resources. Should be called before terminating the application.

setLeftTriggerDeadZone

public void setLeftTriggerDeadZone(double zone)

Sets the dead zone for LeftTrigger. Report 0 if the measured magnitude is lower than the dead zone value.

Parameters:

zone - the zone with no notifications, no change if < 0 or > 1

setRightTriggerDeadZone

public void setRightTriggerDeadZone(double zone)

Sets the dead zone for RightTrigger. Report 0 if the measured value is lower than the dead zone value.

Parameters:

zone - the zone with no notifications, no change if < 0 or > 1

setLeftThumbDeadZone

public void setLeftThumbDeadZone(double zone)

Sets the dead zone for the left thumb. Report magnitude 0 if the measured magnitude is lower than the dead zone value.

Parameters:

zone - the zone to report magnitude 0

setRightThumbDeadZone

public void setRightThumbDeadZone(double zone)

Sets the dead zone for the right thumb. Report magnitude 0 if the measured magnitude is lower than the dead zone value.

Parameters:

zone - the zone to report magnitude 0

vibrate

public void vibrate(int leftVal,
           int rightVal)

Starts vibration with given left und right intensity. Returns immediately. Set left and right intensity to 0 to stop vibration.

Parameters:

leftVal - left intensity 0..65535

rightVal - right intensity 0..65535

vibrate

public void vibrate(int leftVal,
           int rightVal,
           int duration)

Vibrates with given left und right intensity for the given duration. Returns when vibration stops.

Parameters:

leftVal - left intensity 0..65535

rightVal - right intensity 0..65535

duration - rightVal vibration time in ms

isConnected

public boolean isConnected()

Returns true if the last native polling call to the controller was successful.

Returns:

true, if the controller responded, otherwise false

addXboxControllerListener

public void addXboxControllerListener(XboxControllerListener xboxControllerListener)

Registers the given XboxControllerListener and starts polling the event queue. If a listener is already registered, stops its notifications. If null is given, stops the notification of an already registerd listener.

Parameters:

xboxControllerListener - the XboxControllerListener to register

getVersion

public static java.lang.String getVersion()

Returns version information.

Returns:

the version information

setDebug

public void setDebug(boolean on)

Displays debug information when the native thread sends data to the FIFO queue and when the Java thread receives it.

Parameters:

on - if true, debug information is displayed at System.out