400 lines
9.5 KiB
Java
400 lines
9.5 KiB
Java
/*
|
|
* Copyright (c) 2002-2004 Lightweight Java Game Library Project
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are
|
|
* met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* * Neither the name of 'Light Weight Java Game Library' nor the names of
|
|
* its contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
package org.lwjgl.input;
|
|
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
import org.lwjgl.Sys;
|
|
import org.lwjgl.opengl.Window;
|
|
|
|
/**
|
|
* $Id$
|
|
* <br>
|
|
* A raw Controller interface. This can be used to poll the current state of a
|
|
* controllers buttons, and axis positions. The axis positions
|
|
* are returned as ints in the range -1000 to 1000.
|
|
*
|
|
* No buffering is available.
|
|
*
|
|
* Currently n (native limits) buttons, the x, y, z axis (also rotational x,y ,
|
|
* z axis) is supported along with a POV (or HAT) and a slider
|
|
*
|
|
* The Controller implementation currently only supports the first attached device.
|
|
*
|
|
* @author Brian Matzon <brian@matzon.dk>
|
|
* @version $Revision$
|
|
*/
|
|
public class Controller {
|
|
|
|
/** Has the controller been created? */
|
|
private static boolean created;
|
|
|
|
/** The controller buttons status */
|
|
private static boolean[] buttons;
|
|
|
|
/** X position, range -1000 to 1000 */
|
|
private static int x = 0;
|
|
|
|
/** X rotational position, range -1000 to 1000 */
|
|
private static int rx = 0;
|
|
|
|
/** Y position, range -1000 to 1000 */
|
|
private static int y = 0;
|
|
|
|
/** Y rotational position, range -1000 to 1000 */
|
|
private static int ry = 0;
|
|
|
|
/** Z position, range -1000 to 1000 */
|
|
private static int z = 0;
|
|
|
|
/** Z rotational position, range -1000 to 1000 */
|
|
private static int rz = 0;
|
|
|
|
/** Position of Point of View from -1 to 27000 (360 degrees) */
|
|
private static int pov;
|
|
|
|
/** Slider position, range -1000 to 1000 */
|
|
private static int slider = 0;
|
|
|
|
/** Constant specifying centered POV */
|
|
public static final int POV_CENTER = -1;
|
|
|
|
/** Constant specifying nortward POV */
|
|
public static final int POV_NORTH = 0;
|
|
|
|
/** Constant specifying southward POV */
|
|
public static final int POV_SOUTH = 18000;
|
|
|
|
/** Constant specifying eastward POV */
|
|
public static final int POV_EAST = 27000;
|
|
|
|
/** Constant specifying westward POV */
|
|
public static final int POV_WEST = 9000;
|
|
|
|
/** Number of buttons on the controller */
|
|
private static int buttonCount = -1;
|
|
|
|
/** Does this controller support a x axis */
|
|
private static boolean hasXAxis = false;
|
|
|
|
/** Does this controller support a rotational x axis */
|
|
private static boolean hasRXAxis = false;
|
|
|
|
/** Does this controller support an y axis */
|
|
private static boolean hasYAxis = false;
|
|
|
|
/** Does this controller support a rotational y axis */
|
|
private static boolean hasRYAxis = false;
|
|
|
|
/** Does this controller support a z axis */
|
|
private static boolean hasZAxis = false;
|
|
|
|
/** Does this controller support a rotational z axis */
|
|
private static boolean hasRZAxis = false;
|
|
|
|
/** Does this controller support a Point-Of-View (hat) */
|
|
private static boolean hasPOV = false;
|
|
|
|
/** Does this controller support a slider */
|
|
private static boolean hasSlider = false;
|
|
|
|
/** Button names. These are set upon create(), to names like BUTTON0, BUTTON1, etc. */
|
|
private static String[] buttonName;
|
|
private static final Map buttonMap = new HashMap(8);
|
|
|
|
/** Lazy initialization */
|
|
private static boolean initialized;
|
|
|
|
/**
|
|
* Controller cannot be constructed.
|
|
*/
|
|
private Controller() {
|
|
}
|
|
|
|
/**
|
|
* Static initialization
|
|
*/
|
|
private static void initialize() {
|
|
if (initialized)
|
|
return;
|
|
Sys.initialize();
|
|
initIDs();
|
|
|
|
// Assign names to all the buttons
|
|
buttonName = new String[8];
|
|
for (int i = 0; i < 8; i ++) {
|
|
buttonName[i] = "BUTTON" + i;
|
|
buttonMap.put(buttonName[i], new Integer(i));
|
|
}
|
|
|
|
initialized = true;
|
|
}
|
|
|
|
/**
|
|
* "Create" the controller. The display must first have been created.
|
|
* @throws Exception if the controller could not be created for any reason
|
|
*/
|
|
public static void create() throws Exception {
|
|
if (!Window.isCreated())
|
|
throw new IllegalStateException("Window must be created before you can create Controller");
|
|
initialize();
|
|
|
|
if (created) {
|
|
return;
|
|
}
|
|
|
|
nCreate();
|
|
|
|
created = true;
|
|
}
|
|
|
|
/**
|
|
* @return true if the controller has been created
|
|
*/
|
|
public static boolean isCreated() {
|
|
return created;
|
|
}
|
|
|
|
/**
|
|
* "Destroy" the controller
|
|
*/
|
|
public static void destroy() {
|
|
if (!created) {
|
|
return;
|
|
}
|
|
|
|
created = false;
|
|
nDestroy();
|
|
}
|
|
|
|
/**
|
|
* Polls the controller.
|
|
*/
|
|
public static void poll() {
|
|
if (!created)
|
|
throw new IllegalStateException("Controller must be created before you can poll the device");
|
|
nPoll();
|
|
}
|
|
|
|
/**
|
|
* Tests if a particular button is down.
|
|
*
|
|
* @param button The index of the button you wish to test (0..buttonCount-1)
|
|
* @return true if the specified button is down
|
|
* @see #buttonCount
|
|
*/
|
|
public static boolean isButtonDown(int button) {
|
|
if (!created)
|
|
throw new IllegalStateException("Controller must be created before you can query button state");
|
|
return buttons[button];
|
|
}
|
|
|
|
/**
|
|
* @return true if the controller is buffered
|
|
*/
|
|
public static boolean isBuffered() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Read the controller's input buffer. This is not yet implemented in LWJGL so
|
|
* it always throws a RuntimeException.
|
|
*/
|
|
public static void read() {
|
|
throw new UnsupportedOperationException("Buffering is not implemented for Controllers.");
|
|
}
|
|
|
|
/**
|
|
* Gets a button's name
|
|
* @param button The button
|
|
* @return a String with the button's human readable name in it or null if the button is unnamed
|
|
*/
|
|
public static String getButtonName(int button) {
|
|
if (button < 0 || button >= buttonName.length)
|
|
return null;
|
|
else
|
|
return buttonName[button];
|
|
}
|
|
|
|
/**
|
|
* Get's a button's index. If the button is unrecognised then -1 is returned.
|
|
* @param buttonName The button name
|
|
*/
|
|
public static int getButtonIndex(String buttonName) {
|
|
Integer ret = (Integer) buttonMap.get(buttonName);
|
|
if (ret == null)
|
|
return -1;
|
|
else
|
|
return ret.intValue();
|
|
}
|
|
|
|
/**
|
|
* Native method to poll the controller
|
|
*/
|
|
private static native void nPoll();
|
|
|
|
/**
|
|
* Native method to create the controller
|
|
*/
|
|
private static native void nCreate() throws Exception;
|
|
|
|
/**
|
|
* Native method the destroy the controller
|
|
*/
|
|
private static native void nDestroy();
|
|
|
|
/**
|
|
* Register fields with the native library
|
|
*/
|
|
private static native void initIDs();
|
|
/**
|
|
* @return Returns the buttonCount.
|
|
*/
|
|
public static int getButtonCount() {
|
|
return buttonCount;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether POV is supported
|
|
*/
|
|
public static boolean hasPOV() {
|
|
return hasPOV;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a rotational x axis is supported
|
|
*/
|
|
public static boolean hasRXAxis() {
|
|
return hasRXAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a rotational y axis is supported
|
|
*/
|
|
public static boolean hasRYAxis() {
|
|
return hasRYAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a rotational z axis is supported
|
|
*/
|
|
public static boolean hasRZAxis() {
|
|
return hasRZAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a slider is supported
|
|
*/
|
|
public static boolean hasSlider() {
|
|
return hasSlider;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a x axis is supported
|
|
*/
|
|
public static boolean hasXAxis() {
|
|
return hasXAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a y axis is supported
|
|
*/
|
|
public static boolean hasYAxis() {
|
|
return hasYAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns whether a z axis is supported
|
|
*/
|
|
public static boolean hasZAxis() {
|
|
return hasZAxis;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the POV value
|
|
*/
|
|
public static int getPov() {
|
|
return pov;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the rotational value of the x axis
|
|
*/
|
|
public static int getRx() {
|
|
return rx;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the rotational value of the y axis
|
|
*/
|
|
public static int getRy() {
|
|
return ry;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the rotational value of the z axis
|
|
*/
|
|
public static int getRz() {
|
|
return rz;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the slider value
|
|
*/
|
|
public static int getSlider() {
|
|
return slider;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the x axis value
|
|
*/
|
|
public static int getX() {
|
|
return x;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the y axis value
|
|
*/
|
|
public static int getY() {
|
|
return y;
|
|
}
|
|
|
|
/**
|
|
* @return Returns the z axis value
|
|
*/
|
|
public static int getZ() {
|
|
return z;
|
|
}
|
|
}
|