535 lines
16 KiB
Java
535 lines
16 KiB
Java
/*
|
|
* Copyright (c) 2002-2004 LWJGL 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 'LWJGL' 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.nio.ByteBuffer;
|
|
import java.nio.IntBuffer;
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
import org.lwjgl.BufferUtils;
|
|
import org.lwjgl.LWJGLException;
|
|
import org.lwjgl.LWJGLUtil;
|
|
import org.lwjgl.Sys;
|
|
import org.lwjgl.opengl.Display;
|
|
|
|
/**
|
|
* $Id$
|
|
* <br>
|
|
* A raw Mouse interface. This can be used to poll the current state of the
|
|
* mouse buttons, and determine the mouse movement delta since the last poll.
|
|
*
|
|
* n buttons supported, n being a native limit. A scrolly wheel is also
|
|
* supported, if one such is available. Movement is reported as delta from
|
|
* last position or as an absolute position. If the window has been created
|
|
* the absolute position will be clamped to 0 - Display (width | height)
|
|
*
|
|
* @author cix_foo <cix_foo@users.sourceforge.net>
|
|
* @author elias_naur <elias_naur@users.sourceforge.net>
|
|
* @author Brian Matzon <brian@matzon.dk>
|
|
* @version $Revision$
|
|
*/
|
|
public class Mouse {
|
|
/** Mouse constraint */
|
|
private static int width, height;
|
|
|
|
/** Has the mouse been created? */
|
|
private static boolean created;
|
|
|
|
/** The mouse buttons status from the last poll */
|
|
private static ByteBuffer buttons;
|
|
|
|
/** Mouse absolute X position in pixels */
|
|
private static int x;
|
|
|
|
/** Mouse absolute Y position in pixels */
|
|
private static int y;
|
|
|
|
/** Buffer to hold the deltas dx, dy and dwheel */
|
|
private static IntBuffer coord_buffer;
|
|
|
|
/** Delta X */
|
|
private static int dx;
|
|
|
|
/** Delta Y */
|
|
private static int dy;
|
|
|
|
/** Delta Z */
|
|
private static int dwheel;
|
|
|
|
/** Number of buttons supported by the mouse */
|
|
private static int buttonCount = -1;
|
|
|
|
/** Does this mouse support a scroll wheel */
|
|
private static boolean hasWheel;
|
|
|
|
/** The current native cursor, if any */
|
|
private static Cursor currentCursor;
|
|
|
|
/** Button names. These are set upon create(), to names like BUTTON0, BUTTON1, etc. */
|
|
private static String[] buttonName;
|
|
|
|
/** hashmap of button names, for fast lookup */
|
|
private static final Map buttonMap = new HashMap(16);
|
|
|
|
/** Lazy initialization */
|
|
private static boolean initialized;
|
|
|
|
/** The mouse button events from the last read */
|
|
private static IntBuffer readBuffer;
|
|
|
|
/** The current mouse event button being examined */
|
|
private static int eventButton;
|
|
|
|
/** The current state of the button being examined in the event queue */
|
|
private static boolean eventState;
|
|
|
|
/** The current delta of the mouse in the event queue */
|
|
private static int event_dx;
|
|
private static int event_dy;
|
|
private static int event_dwheel;
|
|
/** The current absolute position of the mouse in the event queue */
|
|
private static int event_x;
|
|
private static int event_y;
|
|
|
|
/** Buffer size in events */
|
|
private static final int BUFFER_SIZE = 50;
|
|
/** Event size in elements */
|
|
private static final int EVENT_SIZE = 5;
|
|
|
|
private static boolean isGrabbed;
|
|
|
|
/** Whether we're running windows - which need to manually update cursor animation */
|
|
private static final boolean isWindows = System.getProperty("os.name").startsWith("Win");
|
|
|
|
/**
|
|
* Mouse cannot be constructed.
|
|
*/
|
|
private Mouse() {
|
|
}
|
|
|
|
/**
|
|
* Gets the currently bound native cursor, if any.
|
|
*
|
|
* @return the currently bound native cursor, if any.
|
|
*/
|
|
public static Cursor getNativeCursor() {
|
|
return currentCursor;
|
|
}
|
|
|
|
/**
|
|
* Binds a native cursor. If the cursor argument is null, the
|
|
* native cursor is disabled, as if native cursors were not supported.
|
|
*
|
|
* NOTE: The native cursor is not constrained to the window, but
|
|
* relative events will not be generated if the cursor is outside.
|
|
* The initial position of the cursor is the middle of the window,
|
|
* that is, {window_width/2, window_height/2}.
|
|
* The cursor will be moved to this origin when a
|
|
* native cursor is set and the previous cursor is null.
|
|
*
|
|
* @param cursor the native cursor object to bind. May be null.
|
|
* @return The previous Cursor object set, or null.
|
|
* @throws LWJGLException if the cursor could not be set for any reason
|
|
*/
|
|
public static Cursor setNativeCursor(Cursor cursor) throws LWJGLException {
|
|
if ((Cursor.getCapabilities() & Cursor.CURSOR_ONE_BIT_TRANSPARENCY) == 0)
|
|
throw new IllegalStateException("Mouse doesn't support native cursors");
|
|
Cursor oldCursor = currentCursor;
|
|
currentCursor = cursor;
|
|
if (isCreated()) {
|
|
if (currentCursor != null) {
|
|
Display.getImplementation().setNativeCursor(currentCursor.getHandle());
|
|
currentCursor.setTimeout();
|
|
} else {
|
|
Display.getImplementation().setNativeCursor(null);
|
|
}
|
|
}
|
|
return oldCursor;
|
|
}
|
|
|
|
/**
|
|
* Static initialization
|
|
*/
|
|
private static void initialize() {
|
|
Sys.initialize();
|
|
|
|
// Assign names to all the buttons
|
|
buttonName = new String[16];
|
|
for (int i = 0; i < 16; i++) {
|
|
buttonName[i] = "BUTTON" + i;
|
|
buttonMap.put(buttonName[i], new Integer(i));
|
|
}
|
|
|
|
initialized = true;
|
|
}
|
|
|
|
private static void resetMouse() {
|
|
dx = dy = dwheel = 0;
|
|
width = Display.getDisplayMode().getWidth();
|
|
height = Display.getDisplayMode().getHeight();
|
|
x = width / 2;
|
|
y = height / 2;
|
|
readBuffer.clear();
|
|
}
|
|
|
|
/**
|
|
* "Create" the mouse. The display must first have been created.
|
|
* Initially, the mouse is not grabbed and the delta values are reported
|
|
* with respect to the center of the display.
|
|
*
|
|
* @throws LWJGLException if the mouse could not be created for any reason
|
|
*/
|
|
public static void create() throws LWJGLException {
|
|
if (!Display.isCreated()) throw new IllegalStateException("Display must be created prior to creating mouse");
|
|
|
|
if (!initialized)
|
|
initialize();
|
|
if (created) return;
|
|
Display.getImplementation().createMouse();
|
|
hasWheel = Display.getImplementation().hasWheel();
|
|
created = true;
|
|
|
|
// set mouse buttons
|
|
buttonCount = Display.getImplementation().getButtonCount();
|
|
buttons = BufferUtils.createByteBuffer(buttonCount);
|
|
coord_buffer = BufferUtils.createIntBuffer(3);
|
|
if (currentCursor != null)
|
|
setNativeCursor(currentCursor);
|
|
readBuffer = BufferUtils.createIntBuffer(EVENT_SIZE * BUFFER_SIZE);
|
|
readBuffer.limit(0);
|
|
setGrabbed(isGrabbed);
|
|
}
|
|
|
|
/**
|
|
* @return true if the mouse has been created
|
|
*/
|
|
public static boolean isCreated() {
|
|
return created;
|
|
}
|
|
|
|
/**
|
|
* "Destroy" the mouse.
|
|
*/
|
|
public static void destroy() {
|
|
if (!created) return;
|
|
created = false;
|
|
buttons = null;
|
|
coord_buffer = null;
|
|
|
|
Display.getImplementation().destroyMouse();
|
|
}
|
|
|
|
/**
|
|
* Polls the mouse for its current state. Access the polled values using the
|
|
* get<value> methods.
|
|
* By using this method, it is possible to "miss" mouse click events if you don't
|
|
* poll fast enough.
|
|
*
|
|
* To use buffered values, you have to call <code>next</code> for each event you
|
|
* want to read. You can query which button caused the event by using
|
|
* <code>getEventButton</code>. To get the state of that button, for that event, use
|
|
* <code>getEventButtonState</code>.
|
|
*
|
|
* @see org.lwjgl.input.Mouse#next()
|
|
* @see org.lwjgl.input.Mouse#getEventButton()
|
|
* @see org.lwjgl.input.Mouse#getEventButtonState()
|
|
* @see org.lwjgl.input.Mouse#isButtonDown(int button)
|
|
* @see org.lwjgl.input.Mouse#getX()
|
|
* @see org.lwjgl.input.Mouse#getY()
|
|
* @see org.lwjgl.input.Mouse#getDX()
|
|
* @see org.lwjgl.input.Mouse#getDY()
|
|
* @see org.lwjgl.input.Mouse#getDWheel()
|
|
*/
|
|
public static void poll() {
|
|
if (!created) throw new IllegalStateException("Mouse must be created before you can poll it");
|
|
Display.getImplementation().pollMouse(coord_buffer, buttons);
|
|
|
|
/* If we're grabbed, poll returns mouse deltas, if not it returns absolute coordinates */
|
|
int poll_coord1 = coord_buffer.get(0);
|
|
int poll_coord2 = coord_buffer.get(1);
|
|
/* The wheel is always relative */
|
|
int poll_dwheel = coord_buffer.get(2);
|
|
|
|
if (isGrabbed()) {
|
|
dx += poll_coord1;
|
|
dy += poll_coord2;
|
|
x += poll_coord1;
|
|
y += poll_coord2;
|
|
} else {
|
|
x = poll_coord1;
|
|
y = poll_coord2;
|
|
}
|
|
x = Math.min(width - 1, Math.max(0, x));
|
|
y = Math.min(height - 1, Math.max(0, y));
|
|
dwheel += poll_dwheel;
|
|
read();
|
|
}
|
|
|
|
private static void read() {
|
|
readBuffer.compact();
|
|
int numEvents = Display.getImplementation().readMouse(readBuffer, readBuffer.position());
|
|
readBuffer.position(readBuffer.position() + numEvents * EVENT_SIZE);
|
|
readBuffer.flip();
|
|
}
|
|
|
|
/**
|
|
* See if a particular mouse button is down.
|
|
*
|
|
* @param button The index of the button you wish to test (0..getButtonCount-1)
|
|
* @return true if the specified button is down
|
|
*/
|
|
public static boolean isButtonDown(int button) {
|
|
if (!created) throw new IllegalStateException("Mouse must be created before you can poll the button state");
|
|
if (button >= buttonCount || button < 0)
|
|
return false;
|
|
else
|
|
return buttons.get(button) == 1;
|
|
}
|
|
|
|
/**
|
|
* 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 >= buttonName.length || button < 0)
|
|
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();
|
|
}
|
|
|
|
/**
|
|
* Gets the next mouse event. You can query which button caused the event by using
|
|
* <code>getEventButton()</code> (if any). To get the state of that key, for that event, use
|
|
* <code>getEventButtonState</code>. To get the current mouse delta values use <code>getEventDX()</code>,
|
|
* <code>getEventDY()</code> and <code>getEventDZ()</code>.
|
|
* @see org.lwjgl.input.Mouse#getEventButton()
|
|
* @see org.lwjgl.input.Mouse#getEventButtonState()
|
|
* @return true if a mouse event was read, false otherwise
|
|
*/
|
|
public static boolean next() {
|
|
if (!created) throw new IllegalStateException("Mouse must be created before you can read events");
|
|
if (readBuffer.hasRemaining()) {
|
|
eventButton = readBuffer.get();
|
|
eventState = readBuffer.get() != 0;
|
|
if (isGrabbed()) {
|
|
event_dx = readBuffer.get();
|
|
event_dy = readBuffer.get();
|
|
event_x += event_dx;
|
|
event_y += event_dy;
|
|
} else {
|
|
event_x = readBuffer.get();
|
|
event_y = readBuffer.get();
|
|
}
|
|
event_x = Math.min(width - 1, Math.max(0, event_x));
|
|
event_y = Math.min(height - 1, Math.max(0, event_y));
|
|
event_dwheel = readBuffer.get();
|
|
return true;
|
|
} else
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return Current events button. Returns -1 if no button state was changed
|
|
*/
|
|
public static int getEventButton() {
|
|
return eventButton;
|
|
}
|
|
|
|
/**
|
|
* Get the current events button state. If <code>getEventButton()</code> is -1,
|
|
* and IllegalStateException is thrown.
|
|
* @return Current events button state.
|
|
*/
|
|
public static boolean getEventButtonState() {
|
|
if (eventButton == -1)
|
|
throw new IllegalStateException("Current event has no button state change");
|
|
return eventState;
|
|
}
|
|
|
|
/**
|
|
* @return Current events delta x. Only valid when the mouse is grabbed.
|
|
*/
|
|
public static int getEventDX() {
|
|
if (!isGrabbed())
|
|
throw new IllegalStateException("X, Y deltas are only available when the mouse is grabbed. Use getEventX()/getEventY() instead.");
|
|
return event_dx;
|
|
}
|
|
|
|
/**
|
|
* @return Current events delta y. Only valid when the mouse is grabbed.
|
|
*/
|
|
public static int getEventDY() {
|
|
if (!isGrabbed())
|
|
throw new IllegalStateException("X, Y deltas are only available when the mouse is grabbed. Use getEventX()/getEventY() instead.");
|
|
return event_dy;
|
|
}
|
|
|
|
/**
|
|
* @return Current events absolute x. Only valid when the mouse is not grabbed.
|
|
*/
|
|
public static int getEventX() {
|
|
return event_x;
|
|
}
|
|
|
|
/**
|
|
* @return Current events absolute y. Only valid when the mouse is not grabbed.
|
|
*/
|
|
public static int getEventY() {
|
|
return event_y;
|
|
}
|
|
|
|
/**
|
|
* @return Current events delta z
|
|
*/
|
|
public static int getEventDWheel() {
|
|
return event_dwheel;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the absolute position. If the Display has been created
|
|
* x will be clamped to 0...width-1.
|
|
*
|
|
* @return Absolute x axis position of mouse
|
|
*/
|
|
public static int getX() {
|
|
return x;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the absolute position. If the Display has been created
|
|
* y will be clamped to 0...height-1.
|
|
*
|
|
* @return Absolute y axis position of mouse
|
|
*/
|
|
public static int getY() {
|
|
return y;
|
|
}
|
|
|
|
/**
|
|
* @return Movement on the x axis since last time getDX() was called. Only valid when the mouse is grabbed.
|
|
*/
|
|
public static int getDX() {
|
|
if (!isGrabbed())
|
|
throw new IllegalStateException("X, Y deltas are only available when the mouse is grabbed. Use getEventX()/getEventY() instead.");
|
|
int result = dx;
|
|
dx = 0;
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* @return Movement on the y axis since last time getDY() was called. Only valid when the mouse is grabbed.
|
|
*/
|
|
public static int getDY() {
|
|
if (!isGrabbed())
|
|
throw new IllegalStateException("X, Y deltas are only available when the mouse is grabbed. Use getEventX()/getEventY() instead.");
|
|
int result = dy;
|
|
dy = 0;
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* @return Movement of the wheel since last time getDWheel() was called
|
|
*/
|
|
public static int getDWheel() {
|
|
int result = dwheel;
|
|
dwheel = 0;
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* @return Number of buttons on this mouse
|
|
*/
|
|
public static int getButtonCount() {
|
|
return buttonCount;
|
|
}
|
|
|
|
/**
|
|
* @return Whether or not this mouse has wheel support
|
|
*/
|
|
public static boolean hasWheel() {
|
|
return hasWheel;
|
|
}
|
|
|
|
/**
|
|
* @return whether or not the mouse has grabbed the cursor
|
|
*/
|
|
public static boolean isGrabbed() {
|
|
return isGrabbed;
|
|
}
|
|
|
|
/**
|
|
* Sets whether or not the mouse has grabbed the cursor
|
|
* (and thus hidden). If grab is false, the getX() and getY()
|
|
* will return delta movement in pixels clamped to the display
|
|
* dimensions, from the center of the display.
|
|
*
|
|
* @param grab whether the mouse should be grabbed
|
|
*/
|
|
public static void setGrabbed(boolean grab) {
|
|
isGrabbed = grab;
|
|
if (isCreated()) {
|
|
Display.getImplementation().grabMouse(isGrabbed);
|
|
resetMouse();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Updates the cursor, so that animation can be changed if needed.
|
|
* This method is called automatically by the window on its update, and
|
|
* shouldn't be called otherwise
|
|
*/
|
|
public static void updateCursor() {
|
|
if (isWindows && currentCursor != null && currentCursor.hasTimedOut()) {
|
|
currentCursor.nextCursor();
|
|
try {
|
|
setNativeCursor(currentCursor);
|
|
} catch (LWJGLException e) {
|
|
if (LWJGLUtil.DEBUG) e.printStackTrace();
|
|
}
|
|
}
|
|
}
|
|
}
|