com.jme3.input.lwjgl.GlfwMouseInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-lwjgl3 Show documentation
Show all versions of jme3-lwjgl3 Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* 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 'jMonkeyEngine' 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 com.jme3.input.lwjgl;
import com.jme3.cursors.plugins.JmeCursor;
import com.jme3.input.MouseInput;
import com.jme3.input.RawInputListener;
import com.jme3.input.event.MouseButtonEvent;
import com.jme3.input.event.MouseMotionEvent;
import com.jme3.math.Vector2f;
import com.jme3.system.lwjgl.LwjglWindow;
import com.jme3.system.lwjgl.WindowSizeListener;
import com.jme3.util.BufferUtils;
import java.nio.ByteBuffer;
import java.nio.IntBuffer;
import java.util.ArrayDeque;
import java.util.HashMap;
import java.util.Map;
import java.util.Queue;
import java.util.logging.Logger;
import org.lwjgl.glfw.*;
import static org.lwjgl.glfw.GLFW.*;
import org.lwjgl.system.MemoryStack;
import org.lwjgl.system.MemoryUtil;
/**
* Captures mouse input using GLFW callbacks. It then temporarily stores these
* in event queues which are processed in the {@link #update()} method. Due to
* some of the GLFW button IDs, there is a conversion method in this class which
* will convert the GLFW left, middle and right mouse button to JME3 left,
* middle and right button codes.
*
* @author Daniel Johansson (dannyjo)
* @since 3.1
*/
public class GlfwMouseInput implements MouseInput {
private static final Logger logger = Logger.getLogger(GlfwMouseInput.class.getName());
private static final int WHEEL_SCALE = 120;
private static long[] createGlfwCursor(final JmeCursor jmeCursor) {
long[] cursorArray = new long[jmeCursor.getNumImages()];
for (int i = 0; i < jmeCursor.getNumImages(); i++) {
final ByteBuffer buffer = transformCursorImage(jmeCursor.getImagesData(), jmeCursor.getWidth(), jmeCursor.getHeight(), i);
final GLFWImage glfwImage = new GLFWImage(BufferUtils.createByteBuffer(GLFWImage.SIZEOF));
glfwImage.set(jmeCursor.getWidth(), jmeCursor.getHeight(), buffer);
final int hotspotX = jmeCursor.getXHotSpot();
final int hotspotY = jmeCursor.getHeight() - jmeCursor.getYHotSpot();
cursorArray[i] = glfwCreateCursor(glfwImage, hotspotX, hotspotY);
}
return cursorArray;
}
private static ByteBuffer transformCursorImage(final IntBuffer imageData, final int width, final int height,
final int index) {
final ByteBuffer byteBuffer = BufferUtils.createByteBuffer(width * height * 4);
// Transform image: ARGB -> RGBA, vertical flip
for (int y = height - 1; y >= 0; --y) {
for (int x = 0; x < width; ++x) {
int pixel = imageData.get(width * height * index + y * width + x);
byteBuffer.put((byte) ((pixel >> 16) & 0xFF)); // red
byteBuffer.put((byte) ((pixel >> 8) & 0xFF)); // green
byteBuffer.put((byte) (pixel & 0xFF)); // blue
byteBuffer.put((byte) ((pixel >> 24) & 0xFF)); // alpha
}
}
byteBuffer.flip();
return byteBuffer;
}
private final Map jmeToGlfwCursorMap = new HashMap<>();
private final Queue mouseMotionEvents = new ArrayDeque<>();
private final Queue mouseButtonEvents = new ArrayDeque<>();
private final LwjglWindow context;
private WindowSizeListener windowSizeListener;
private RawInputListener listener;
private IntBuffer currentCursorDelays;
private GLFWCursorPosCallback cursorPosCallback;
private GLFWScrollCallback scrollCallback;
private GLFWMouseButtonCallback mouseButtonCallback;
private long[] currentCursor;
private double currentCursorFrameStartTime = 0.0;
private int currentCursorFrame = 0;
private int mouseX;
private int mouseY;
private int mouseWheel;
private int currentHeight;
private boolean cursorVisible;
private boolean initialized;
private final Vector2f inputScale = new Vector2f();
public GlfwMouseInput(final LwjglWindow context) {
this.context = context;
this.cursorVisible = true;
}
private void onCursorPos(final long window, final double xpos, final double ypos) {
context.getWindowContentScale(inputScale);
int x = (int) Math.round(xpos * inputScale.x);
int y = (int) Math.round((currentHeight - ypos) * inputScale.y);
int xDelta = x - mouseX;
int yDelta = y - mouseY;
mouseX = x;
mouseY = y;
if (xDelta != 0 || yDelta != 0) {
final MouseMotionEvent mouseMotionEvent = new MouseMotionEvent(x, y, xDelta, yDelta, mouseWheel, 0);
mouseMotionEvent.setTime(getInputTimeNanos());
mouseMotionEvents.add(mouseMotionEvent);
}
}
private void onWheelScroll(final long window, final double xOffset, final double yOffset) {
mouseWheel += yOffset;
final MouseMotionEvent mouseMotionEvent = new MouseMotionEvent(mouseX, mouseY, 0, 0, mouseWheel, (int) Math.round(yOffset));
mouseMotionEvent.setTime(getInputTimeNanos());
mouseMotionEvents.add(mouseMotionEvent);
}
private void onMouseButton(final long window, final int button, final int action, final int mods) {
final boolean pressed = action == GLFW_PRESS;
final MouseButtonEvent mouseButtonEvent = new MouseButtonEvent(convertButton(button), pressed, mouseX, mouseY);
mouseButtonEvent.setTime(getInputTimeNanos());
mouseButtonEvents.add(mouseButtonEvent);
}
@Override
public void initialize() {
initCallbacks();
if (listener != null) {
sendFirstMouseEvent();
}
setCursorVisible(cursorVisible);
logger.fine("Mouse created.");
initialized = true;
}
/**
* Re-initializes the mouse input context window specific callbacks
*/
public void resetContext() {
if (!context.isRenderable()) {
return;
}
closeCallbacks();
initCallbacks();
}
private void initCallbacks() {
final long window = context.getWindowHandle();
try (MemoryStack stack = MemoryStack.stackPush()) {
final IntBuffer width = stack.callocInt(1);
final IntBuffer height = stack.callocInt(1);
glfwGetWindowSize(window, width, height);
width.get();
currentHeight = height.get();
}
initCurrentMousePosition(window);
glfwSetCursorPosCallback(window, cursorPosCallback = new GLFWCursorPosCallback() {
@Override
public void invoke(final long window, final double xpos, final double ypos) {
onCursorPos(window, xpos, ypos);
}
});
glfwSetScrollCallback(window, scrollCallback = new GLFWScrollCallback() {
@Override
public void invoke(final long window, final double xOffset, final double yOffset) {
onWheelScroll(window, xOffset, yOffset * WHEEL_SCALE);
}
});
glfwSetMouseButtonCallback(window, mouseButtonCallback = new GLFWMouseButtonCallback() {
@Override
public void invoke(final long window, final int button, final int action, final int mods) {
onMouseButton(window, button, action, mods);
}
});
context.registerWindowSizeListener(windowSizeListener = ((width, height) -> {
currentHeight = height;
}));
}
private void initCurrentMousePosition(long window) {
double[] x = new double[1];
double[] y = new double[1];
glfwGetCursorPos(window, x, y);
context.getWindowContentScale(inputScale);
mouseX = (int) Math.round(x[0] * inputScale.x);
mouseY = (int) Math.round((currentHeight - y[0]) * inputScale.y);
}
/**
* Send the input listener a special mouse-motion event with zero deltas in
* order to initialize the listener's cursor position.
*/
private void sendFirstMouseEvent() {
assert listener != null;
int xDelta = 0;
int yDelta = 0;
int wheelDelta = 0;
MouseMotionEvent evt = new MouseMotionEvent(mouseX, mouseY, xDelta, yDelta,
mouseWheel, wheelDelta);
evt.setTime(getInputTimeNanos());
listener.onMouseMotionEvent(evt);
}
@Override
public boolean isInitialized() {
return initialized;
}
@Override
public int getButtonCount() {
return GLFW_MOUSE_BUTTON_LAST + 1;
}
@Override
public void update() {
// Manage cursor animation
if (currentCursor != null && currentCursor.length > 1) {
double now = glfwGetTime();
double frameTime = (glfwGetTime() - currentCursorFrameStartTime) * 1000;
if (currentCursorDelays == null || frameTime >= currentCursorDelays.get(currentCursorFrame)) {
currentCursorFrame = ++currentCursorFrame % currentCursor.length;
currentCursorFrameStartTime = now;
glfwSetCursor(context.getWindowHandle(), currentCursor[currentCursorFrame]);
}
}
// Process events
while (!mouseMotionEvents.isEmpty()) {
listener.onMouseMotionEvent(mouseMotionEvents.poll());
}
while (!mouseButtonEvents.isEmpty()) {
listener.onMouseButtonEvent(mouseButtonEvents.poll());
}
}
@Override
public void destroy() {
if (!context.isRenderable()) {
return;
}
closeCallbacks();
currentCursor = null;
currentCursorDelays = null;
for (long[] glfwCursors : jmeToGlfwCursorMap.values()) {
for (long glfwCursor : glfwCursors) {
glfwDestroyCursor(glfwCursor);
}
}
jmeToGlfwCursorMap.clear();
logger.fine("Mouse destroyed.");
}
private void closeCallbacks() {
cursorPosCallback.close();
scrollCallback.close();
mouseButtonCallback.close();
context.removeWindowSizeListener(windowSizeListener);
}
@Override
public void setCursorVisible(boolean visible) {
cursorVisible = visible;
if (!context.isRenderable()) {
return;
}
if (cursorVisible) {
glfwSetInputMode(context.getWindowHandle(), GLFW_CURSOR, GLFW_CURSOR_NORMAL);
} else {
glfwSetInputMode(context.getWindowHandle(), GLFW_CURSOR, GLFW_CURSOR_DISABLED);
}
}
@Override
public void setInputListener(RawInputListener listener) {
this.listener = listener;
if (listener != null && initialized) {
sendFirstMouseEvent();
}
}
@Override
public long getInputTimeNanos() {
return (long) (glfwGetTime() * 1000000000);
}
@Override
public void setNativeCursor(final JmeCursor jmeCursor) {
if (jmeCursor != null) {
final long[] glfwCursor = jmeToGlfwCursorMap.computeIfAbsent(jmeCursor, GlfwMouseInput::createGlfwCursor);
currentCursorFrame = 0;
currentCursor = glfwCursor;
currentCursorDelays = null;
currentCursorFrameStartTime = glfwGetTime();
if (jmeCursor.getImagesDelay() != null) {
currentCursorDelays = jmeCursor.getImagesDelay();
}
glfwSetCursor(context.getWindowHandle(), glfwCursor[currentCursorFrame]);
} else {
currentCursor = null;
currentCursorDelays = null;
glfwSetCursor(context.getWindowHandle(), MemoryUtil.NULL);
}
}
/**
* Simply converts the GLFW button code to a JME button code. If there is no
* match it just returns the GLFW button code. Bear in mind GLFW supports 8
* different mouse buttons.
*
* @param glfwButton the raw GLFW button index.
* @return the mapped {@link MouseInput} button id.
*/
private int convertButton(final int glfwButton) {
switch (glfwButton) {
case GLFW_MOUSE_BUTTON_LEFT:
return MouseInput.BUTTON_LEFT;
case GLFW_MOUSE_BUTTON_MIDDLE:
return MouseInput.BUTTON_MIDDLE;
case GLFW_MOUSE_BUTTON_RIGHT:
return MouseInput.BUTTON_RIGHT;
default:
return glfwButton;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy