com.jme3.input.lwjgl

Class GlfwMouseInput

java.lang.Object

com.jme3.input.lwjgl.GlfwMouseInput

All Implemented Interfaces:

Input, MouseInput

public class GlfwMouseInput
extends java.lang.Object
implements MouseInput

Captures mouse input using GLFW callbacks. It then temporarily stores these in event queues which are processed in the update() method. Due to some of the GLFW button id's 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.

Since:

3.1

Field Summary

Fields inherited from interface com.jme3.input.MouseInput

AXIS_WHEEL, AXIS_X, AXIS_Y, BUTTON_LEFT, BUTTON_MIDDLE, BUTTON_RIGHT

Constructor Summary

Constructors

Constructor and Description
GlfwMouseInput(LwjglWindow context)

Method Summary

Modifier and Type	Method and Description
void	destroy() Ceases listening to events from the device.
int	getButtonCount() Returns the number of buttons the mouse has.
long	getInputTimeNanos()
void	initialize() Initializes the native side to listen into events from the device.
boolean	isInitialized()
void	resetContext() Re-initializes the mouse input context window specific callbacks
void	setCursorVisible(boolean visible) Set whether the mouse cursor should be visible or not.
void	setInputListener(RawInputListener listener) Sets the input listener to receive events from this device.
void	setNativeCursor(JmeCursor jmeCursor) Sets the cursor to use.
void	update() Queries the device for input.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlfwMouseInput

public GlfwMouseInput(LwjglWindow context)

Method Detail

initialize

public void initialize()

Description copied from interface: Input

Initializes the native side to listen into events from the device.

Specified by:

initialize in interface Input

resetContext

public void resetContext()

Re-initializes the mouse input context window specific callbacks

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface Input

Returns:

True if the device has been initialized and not destroyed.

See Also:

Input.initialize(), Input.destroy()

getButtonCount

public int getButtonCount()

Description copied from interface: MouseInput

Returns the number of buttons the mouse has. Typically 3 for most mice.

Specified by:

getButtonCount in interface MouseInput

Returns:

the number of buttons the mouse has.

update

public void update()

Description copied from interface: Input

Queries the device for input. All events should be sent to the RawInputListener set with setInputListener.

Specified by:

update in interface Input

See Also:

Input.setInputListener(com.jme3.input.RawInputListener)

destroy

public void destroy()

Description copied from interface: Input

Ceases listening to events from the device.

Specified by:

destroy in interface Input

setCursorVisible

public void setCursorVisible(boolean visible)

Description copied from interface: MouseInput

Set whether the mouse cursor should be visible or not.

Specified by:

setCursorVisible in interface MouseInput

Parameters:

visible - Whether the mouse cursor should be visible or not.

setInputListener

public void setInputListener(RawInputListener listener)

Description copied from interface: Input

Sets the input listener to receive events from this device. The appropriate events should be dispatched through the callbacks in RawInputListener.

Specified by:

setInputListener in interface Input

Parameters:

listener - the desired listener

getInputTimeNanos

public long getInputTimeNanos()

Specified by:

getInputTimeNanos in interface Input

Returns:

The current absolute time as nanoseconds. This time is expected to be relative to the time given in InputEvents time property.

setNativeCursor

public void setNativeCursor(JmeCursor jmeCursor)

Description copied from interface: MouseInput

Sets the cursor to use.

Specified by:

setNativeCursor in interface MouseInput

Parameters:

jmeCursor - The cursor to use.