Package io.github.ocelot.window.input

Class MouseHandler

java.lang.Object

io.github.ocelot.window.input.MouseHandler

All Implemented Interfaces:

WindowEventListener

public class MouseHandler
extends Object
implements WindowEventListener

Tracks the mouse position, velocity, and pressed buttons. Also supports tracking the mouse while grabbed.

Constructor Summary

Constructors

Constructor	Description
MouseHandler(Window window)

Method Summary

Modifier and Type	Method	Description
void	cursorEntered(Window window, boolean entered)	Called when the mouse enters or exists the window.
double	getAccumulatedDX()
double	getAccumulatedDY()
double	getMouseDX()
double	getMouseDY()
double	getMouseX()
double	getMouseY()
void	grabMouse()	Grabs the mouse by disabling it and moving it to the center of the window.
void	ignoreFirstMovement()	Ignores the first movement velocity of the mouse.
boolean	isButtonPressed(int button)	Checks if the specified mouse button is pressed.
boolean	isMouseGrabbed()
void	mouseMoved(Window window, double x, double y)	Called when the mouse moves.
void	mousePressed(Window window, int button, KeyMods mods)	Called when a mouse button is pressed.
void	mouseReleased(Window window, int button, KeyMods mods)	Called when a mouse button is released.
void	releaseMouse()	Releases the mouse and sets its position to the center of the window.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.ocelot.window.WindowEventListener

charTyped, filesDropped, focusChanged, framebufferResized, keyPressed, keyReleased, keyRepeated, mouseScrolled, windowClosed, windowMoved, windowResized

Constructor Details

MouseHandler

public MouseHandler(Window window)

Method Details

mouseMoved

public void mouseMoved(Window window,
 double x,
 double y)

Description copied from interface: WindowEventListener

Called when the mouse moves.

Specified by:

mouseMoved in interface WindowEventListener

Parameters:

window - The window that fired the event

x - The amount the mouse moved in the x

y - The amount the mouse moved in the y

mousePressed

public void mousePressed(Window window,
 int button,
 KeyMods mods)

Description copied from interface: WindowEventListener

Called when a mouse button is pressed.

Specified by:

mousePressed in interface WindowEventListener

Parameters:

window - The window that fired the event

button - The button that was pressed. Usually one of:

Standard Mouse Buttons

MOUSE_BUTTON_LEFT

MOUSE_BUTTON_RIGHT

MOUSE_BUTTON_MIDDLE

mods - The keyboard modifier flags set when the mouse button was pressed

mouseReleased

public void mouseReleased(Window window,
 int button,
 KeyMods mods)

Description copied from interface: WindowEventListener

Called when a mouse button is released.

Specified by:

mouseReleased in interface WindowEventListener

Parameters:

window - The window that fired the event

button - The button that was released. Usually one of:

Standard Mouse Buttons

MOUSE_BUTTON_LEFT

MOUSE_BUTTON_RIGHT

MOUSE_BUTTON_MIDDLE

mods - The keyboard modifier flags set when the mouse button was released

cursorEntered

public void cursorEntered(Window window,
 boolean entered)

Description copied from interface: WindowEventListener

Called when the mouse enters or exists the window.

Specified by:

cursorEntered in interface WindowEventListener

Parameters:

window - The window that fired the event

entered - Whether the cursor entered or left the window

grabMouse

public void grabMouse()

Grabs the mouse by disabling it and moving it to the center of the window.

releaseMouse

public void releaseMouse()

Releases the mouse and sets its position to the center of the window.

ignoreFirstMovement

public void ignoreFirstMovement()

Ignores the first movement velocity of the mouse.

isButtonPressed

public boolean isButtonPressed(int button)

Checks if the specified mouse button is pressed.

Parameters:

button - The button to check

Returns:

Whether that button is pressed

getMouseX

public double getMouseX()

Returns:

The x position of the mouse

getMouseY

public double getMouseY()

Returns:

The y position of the mouse

getMouseDX

public double getMouseDX()

Returns:

The x velocity of the mouse

getMouseDY

public double getMouseDY()

Returns:

The y velocity of the mouse

isMouseGrabbed

public boolean isMouseGrabbed()

Returns:

Whether the mouse is disabled and not currently visible

getAccumulatedDX

public double getAccumulatedDX()

Returns:

The total x motion of the mouse since the last query if grabbed

getAccumulatedDY

public double getAccumulatedDY()

Returns:

The total y motion of the mouse since the last query if grabbed