de.gurkenlabs.litiengine.input

Class Mouse

java.lang.Object

de.gurkenlabs.litiengine.input.Mouse

All Implemented Interfaces:

IMouse, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class Mouse
extends java.lang.Object
implements IMouse

This implementation provides information about the mouse input in the litiengine.

Constructor Summary

Constructors

Constructor and Description
Mouse() Instantiates a new mouse.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(java.awt.event.MouseListener listener) Register mouse listener.
void	addMouseMotionListener(java.awt.event.MouseMotionListener listener) Register mouse motion listener.
void	addMouseWheelListener(java.awt.event.MouseWheelListener listener) Register mouse wheel listener.
java.awt.geom.Point2D	getLocation() Gets the render location.
java.awt.geom.Point2D	getMapLocation()
java.awt.Point	getTile()
boolean	isGrabMouse()
boolean	isLeftMouseButtonDown()
boolean	isPressed()
boolean	isRightMouseButtonDown()
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
void	onClicked(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)
void	onDragged(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)
void	onMoved(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)
void	onPressed(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)
void	onReleased(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)
void	onWheelMoved(java.util.function.Consumer<java.awt.event.MouseWheelEvent> consumer)
void	removeMouseListener(java.awt.event.MouseListener listener) Unregister mouse listener.
void	removeMouseMotionListener(java.awt.event.MouseMotionListener listener) Unregister mouse motion listener.
void	removeMouseWheelListener(java.awt.event.MouseWheelListener listener) Unregister mouse wheel listener.
void	setGrabMouse(boolean grab) If set to true, the mouse will be locked to the render component of the game.
void	setLocation(double x, double y)
void	setLocation(java.awt.geom.Point2D adjustMouse)

Methods inherited from class java.lang.Object

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

Constructor Detail

Mouse

public Mouse()
      throws java.awt.AWTException

Instantiates a new mouse.

Throws:

java.awt.AWTException - In case the Robot class could not be initialized.

Method Detail

getLocation

public java.awt.geom.Point2D getLocation()

Description copied from interface: IMouse

Gets the render location.

Specified by:

getLocation in interface IMouse

Returns:

the render location

getMapLocation

public java.awt.geom.Point2D getMapLocation()

Specified by:

getMapLocation in interface IMouse

getTile

public java.awt.Point getTile()

Specified by:

getTile in interface IMouse

isGrabMouse

public boolean isGrabMouse()

Specified by:

isGrabMouse in interface IMouse

isLeftMouseButtonDown

public boolean isLeftMouseButtonDown()

Specified by:

isLeftMouseButtonDown in interface IMouse

isPressed

public boolean isPressed()

Specified by:

isPressed in interface IMouse

isRightMouseButtonDown

public boolean isRightMouseButtonDown()

Specified by:

isRightMouseButtonDown in interface IMouse

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

onClicked

public void onClicked(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)

Specified by:

onClicked in interface IMouse

onDragged

public void onDragged(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)

Specified by:

onDragged in interface IMouse

onMoved

public void onMoved(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)

Specified by:

onMoved in interface IMouse

onPressed

public void onPressed(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)

Specified by:

onPressed in interface IMouse

onReleased

public void onReleased(java.util.function.Consumer<java.awt.event.MouseEvent> consumer)

Specified by:

onReleased in interface IMouse

onWheelMoved

public void onWheelMoved(java.util.function.Consumer<java.awt.event.MouseWheelEvent> consumer)

Specified by:

onWheelMoved in interface IMouse

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)

Description copied from interface: IMouse

Register mouse listener.

Specified by:

addMouseListener in interface IMouse

Parameters:

listener - the listener

addMouseMotionListener

public void addMouseMotionListener(java.awt.event.MouseMotionListener listener)

Description copied from interface: IMouse

Register mouse motion listener.

Specified by:

addMouseMotionListener in interface IMouse

Parameters:

listener - the listener

addMouseWheelListener

public void addMouseWheelListener(java.awt.event.MouseWheelListener listener)

Description copied from interface: IMouse

Register mouse wheel listener.

Specified by:

addMouseWheelListener in interface IMouse

Parameters:

listener - the listener

setGrabMouse

public void setGrabMouse(boolean grab)

Description copied from interface: IMouse

If set to true, the mouse will be locked to the render component of the game.

Specified by:

setGrabMouse in interface IMouse

Parameters:

grab - True if the mouse should be grabbed to the RenderComponent, otherwise false.

setLocation

public void setLocation(java.awt.geom.Point2D adjustMouse)

Specified by:

setLocation in interface IMouse

setLocation

public void setLocation(double x,
                        double y)

Specified by:

setLocation in interface IMouse

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener listener)

Description copied from interface: IMouse

Unregister mouse listener.

Specified by:

removeMouseListener in interface IMouse

Parameters:

listener - the listener

removeMouseMotionListener

public void removeMouseMotionListener(java.awt.event.MouseMotionListener listener)

Description copied from interface: IMouse

Unregister mouse motion listener.

Specified by:

removeMouseMotionListener in interface IMouse

Parameters:

listener - the listener

removeMouseWheelListener

public void removeMouseWheelListener(java.awt.event.MouseWheelListener listener)

Description copied from interface: IMouse

Unregister mouse wheel listener.

Specified by:

removeMouseWheelListener in interface IMouse

Parameters:

listener - the listener