Class JInputJoystick

public class JInputJoystick

/**
 *
 * JInput Joystick
 * 
 * 
 * @author TheUzo007
 *         http://theuzo007.wordpress.com
 * 
 * 
 * To use this you need JInput libraries and its files. http://java.net/projects/jinput
 * 
 * This class is intended for use with joysticks of stick or gamepad type (JInput type), 
 * like Logitech Dual Action which is a stick type or Xbox MadCatz which is a gamepad type.
 * It can be used with other types to, but each controller has different components, therefore, 
 * some methods that I wrote are not useful with other types of controller. But 
 * you can always use getComponentValue method and specify controller component 
 * identifier that you need or add your own methods.
 * 
 * JInput javadoc: http://www.newdawnsoftware.com/resources/jinput/apidocs
 * 
 * 
 * More on the blog: http://theuzo007.wordpress.com/2012/09/02/joystick-in-java-with-jinput
 * 
 */
  

Constructor Summary

Constructor and Description
JInputJoystick(net.java.games.input.Controller.Type controllerType) Creates a controller, of type that has been given.
JInputJoystick(net.java.games.input.Controller.Type controllerType_1, net.java.games.input.Controller.Type controllerType_2) Creates a controller, of one of the types that has been given.

Method Summary

Modifier and Type	Method and Description
boolean	componentExists(net.java.games.input.Component.Identifier identifier) Checks if component with given identifier exists.
java.util.ArrayList<java.lang.Boolean>	getButtonsValues() Controller buttons states.
boolean	getButtonValue(int index) Gets value of required button.
float	getComponentValue(net.java.games.input.Component.Identifier identifier) Gets value of component with given identifier.
java.lang.String	getControllerName() Gets the human readable controller name.
net.java.games.input.Controller.Type	getControllerType() Gets the controller type.
float	getHatSwitchPosition() Gets position of the Hat Switch.
int	getNumberOfButtons() How many buttons does controller have?
int	getX_LeftJoystick_Percentage() X position, in percentages, of left controller joystick.
float	getX_LeftJoystick_Value() X position of left controller joystick.
int	getX_RightJoystick_Percentage() X position, in percentages, of right controller joystick.
float	getX_RightJoystick_Value() X position of right controller joystick.
int	getXAxisPercentage() Value of axis named X Axis in percentage.
float	getXAxisValue() Value of axis named X Axis.
int	getXRotationPercentage() Value of axis named X Rotation in percentage.
float	getXRotationValue() Value of axis named X Rotation.
int	getY_LeftJoystick_Percentage() Y position, in percentages, of left controller joystick.
float	getY_LeftJoystick_Value() Y position of left controller joystick.
int	getY_RightJoystick_Percentage() Y position, in percentages, of right controller joystick.
float	getY_RightJoystick_Value() Y position of right controller joystick.
int	getYAxisPercentage() Value of axis named Y Axis in percentage.
float	getYAxisValue() Value of axis named Y Axis.
int	getYRotationPercentage() Value of axis named Y Rotation in percentage.
float	getYRotationValue() Value of axis named Y Rotation.
int	getZAxisPercentage() Value of axis named Z Axis in percentage.
float	getZAxisValue() Value of axis named Z Axis.
int	getZRotationPercentage() Value of axis named Z Rotation in percentage.
float	getZRotationValue() Value of axis named Z Rotation.
boolean	isControllerConnected() Checks if the controller is connected/valid.
boolean	pollController() Check and save current controller state (controller components values).

Methods inherited from class java.lang.Object

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

Constructor Detail

JInputJoystick

public JInputJoystick(net.java.games.input.Controller.Type controllerType)

Creates a controller, of type that has been given.

Parameters:

controllerType - Desired controller type.

JInputJoystick

public JInputJoystick(net.java.games.input.Controller.Type controllerType_1,
              net.java.games.input.Controller.Type controllerType_2)

Creates a controller, of one of the types that has been given. Controller type which is first found will be created.

Parameters:

controllerType_1 - Desired controller type.

controllerType_2 - Desired controller type.

Method Detail

isControllerConnected

public boolean isControllerConnected()

Checks if the controller is connected/valid. It also poll the controller for data, but it doesn't save states of the buttons into buttons array list that is used by getButtonsValues() and getButtonValue(int index) methods.

Returns:

True if controller is connected, false otherwise.

See Also:

pollController()

getControllerType

public net.java.games.input.Controller.Type getControllerType()

Gets the controller type. Throws exception if controller doesn't exists.

Returns:

Type of the controller.

getControllerName

public java.lang.String getControllerName()

Gets the human readable controller name. Throws exception if controller doesn't exists.

Returns:

Controller name.

pollController

public boolean pollController()

Check and save current controller state (controller components values). Must be called every time before using controller state methods (eg. method for x axis value), so that you get latest controller components values.

Returns:

True if controller is connected/valid, false otherwise.

componentExists

public boolean componentExists(net.java.games.input.Component.Identifier identifier)

Checks if component with given identifier exists.

Parameters:

identifier - Identifier that correspond to component.

Returns:

True if component exists or false if not exists.

getComponentValue

public float getComponentValue(net.java.games.input.Component.Identifier identifier)

Gets value of component with given identifier.

Parameters:

identifier - Identifier that correspond to component from which we need value.

Returns:

Component value.

getNumberOfButtons

public int getNumberOfButtons()

How many buttons does controller have?

Returns:

Number of buttons on a controller.

getButtonsValues

public java.util.ArrayList<java.lang.Boolean> getButtonsValues()

Controller buttons states. Index of element in array list correspond to button number on the controller. If element is true then button is pressed, if element is false then button is not pressed.

Returns:

Array list of states of all controller buttons.

getButtonValue

public boolean getButtonValue(int index)

Gets value of required button.

Parameters:

index - Index of a button in array list.

Returns:

True if button is pressed, false otherwise.

getXAxisValue

public float getXAxisValue()

Value of axis named X Axis.

Returns:

X Axis value.

getXAxisPercentage

public int getXAxisPercentage()

Value of axis named X Axis in percentage. Percentages increases from left to right. If idle (in center) returns 50, if joystick axis is pushed to the left edge returns 0 and if it's pushed to the right returns 100.

Returns:

X Axis value in percentage.

getYAxisValue

public float getYAxisValue()

Value of axis named Y Axis.

Returns:

Y Axis value.

getYAxisPercentage

public int getYAxisPercentage()

Value of axis named Y Axis in percentage. Percentages increases from top to bottom. If idle (in center) returns 50, if joystick axis is pushed to the top edge returns 0 and if it is pushed to the bottom returns 100.

Returns:

Y Axis value in percentage.

getZRotationValue

public float getZRotationValue()

Value of axis named Z Rotation.

Returns:

Z Rotation value.

getZRotationPercentage

public int getZRotationPercentage()

Value of axis named Z Rotation in percentage. Percentages increases from top to bottom. If idle (in center) returns 50, if joystick axis is pushed to the top edge returns 0 and if it is pushed to the bottom returns 100.

Returns:

Z Rotation value in percentage.

getZAxisValue

public float getZAxisValue()

Value of axis named Z Axis.

Returns:

Z Axis value.

getZAxisPercentage

public int getZAxisPercentage()

Value of axis named Z Axis in percentage. Percentages increases from left to right. If idle (in center) returns 50, if joystick axis is pushed to the left edge returns 0 and if it's pushed to the right returns 100.

Returns:

Z Axis value in percentage.

getXRotationValue

public float getXRotationValue()

Value of axis named X Rotation.

Returns:

X Rotation value.

getXRotationPercentage

public int getXRotationPercentage()

Value of axis named X Rotation in percentage. Percentages increases from left to right. If idle (in center) returns 50, if joystick axis is pushed to the left edge returns 0 and if it's pushed to the right returns 100.

Returns:

X Rotation value in percentage.

getYRotationValue

public float getYRotationValue()

Value of axis named Y Rotation.

Returns:

Y Rotation value.

getYRotationPercentage

public int getYRotationPercentage()

Value of axis named Y Rotation in percentage. Percentages increases from top to bottom. If idle (in center) returns 50, if joystick axis is pushed to the top edge returns 0 and if it is pushed to the bottom returns 100.

Returns:

Y Rotation value in percentage.

getHatSwitchPosition

public float getHatSwitchPosition()

Gets position of the Hat Switch. Float number that is returned by this method correspond with positions in the JInput class Component.POV.

Returns:

Float number that corresponds with the Hat Switch position.

getX_LeftJoystick_Value

public float getX_LeftJoystick_Value()

X position of left controller joystick. The same as method getXAxisValue().

Returns:

Float value (from -1.0f to 1.0f) corresponding to left controller joystick on x coordinate.

See Also:

getXAxisValue()

getX_LeftJoystick_Percentage

public int getX_LeftJoystick_Percentage()

X position, in percentages, of left controller joystick. The same as method getXAxisPercentage().

Returns:

Int value (from 0 to 100) corresponding to left controller joystick on x coordinate.

See Also:

getXAxisPercentage()

getY_LeftJoystick_Value

public float getY_LeftJoystick_Value()

Y position of left controller joystick. The same as method getYAxisValue().

Returns:

Float value (from -1.0f to 1.0f) corresponding to left controller joystick on y coordinate.

See Also:

getYAxisValue()

getY_LeftJoystick_Percentage

public int getY_LeftJoystick_Percentage()

Y position, in percentages, of left controller joystick. The same as method getYAxisPercentage().

Returns:

Int value (from 0 to 100) corresponding to left controller joystick on y coordinate.

See Also:

getYAxisPercentage()

getX_RightJoystick_Value

public float getX_RightJoystick_Value()

X position of right controller joystick. The same as method getZAxisValue() if controller type is Controller.Type.STICK. The same as method getXRotationValue() if controller type is Controller.Type.GAMEPAD.

Returns:

Float value (from -1.0f to 1.0f) corresponding to right controller joystick on x coordinate.

See Also:

getZAxisValue(), getXRotationValue()

getX_RightJoystick_Percentage

public int getX_RightJoystick_Percentage()

X position, in percentages, of right controller joystick. The same as method getZAxisPercentage() if controller type is Controller.Type.STICK. The same as method getXRotationPercentage() if controller type is Controller.Type.GAMEPAD.

Returns:

Int value (from 0 to 100) corresponding to right controller joystick on x coordinate.

See Also:

getZAxisPercentage(), getXRotationPercentage()

getY_RightJoystick_Value

public float getY_RightJoystick_Value()

Y position of right controller joystick. The same as method getZRotationValue() if controller type is Controller.Type.STICK. The same as method getYRotationValue() if controller type is Controller.Type.GAMEPAD.

Returns:

Float value (from -1.0f to 1.0f) corresponding to right controller joystick on y coordinate.

See Also:

getZRotationValue(), getYRotationValue()

getY_RightJoystick_Percentage

public int getY_RightJoystick_Percentage()

Y position, in percentages, of right controller joystick. The same as method getZRotationPercentage() if controller type is Controller.Type.STICK. The same as method getYRotationPercentage() if controller type is Controller.Type.GAMEPAD.

Returns:

Int value (from 0 to 100) corresponding to right controller joystick on y coordinate.

See Also:

getZRotationPercentage(), getYRotationPercentage()