org.mini2Dx.core.graphics

Class CustomCursor

java.lang.Object

org.mini2Dx.core.graphics.CustomCursor

All Implemented Interfaces:

org.mini2Dx.gdx.InputProcessor

Direct Known Subclasses:

LibgdxCustomCursor

public abstract class CustomCursor
extends java.lang.Object
implements org.mini2Dx.gdx.InputProcessor

Base class for implementing an InputProcessor that sets a custom mouse cursor image based on the mouse state.

Field Summary

Fields

Modifier and Type	Field and Description
protected Pixmap	downPixmap
protected Pixmap	emptyPixmap
protected Pixmap	upPixmap
protected boolean	visible
protected int	xHotspot
protected int	yHotspot

Constructor Summary

Constructors

Constructor and Description
CustomCursor(Pixmap upPixmap, Pixmap downPixmap, int xHotspot, int yHotspot) Constructor

Method Summary

Modifier and Type	Method and Description
Pixmap	getDownPixmap()
Pixmap	getEmptyPixmap()
Pixmap	getUpPixmap()
int	getxHotspot()
int	getyHotspot()
boolean	isVisible()
void	setVisible(boolean visible)
protected abstract void	updateCursorVisibility()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mini2Dx.gdx.InputProcessor

keyDown, keyTyped, keyUp, mouseMoved, scrolled, touchDown, touchDragged, touchUp

Field Detail

upPixmap

protected final Pixmap upPixmap

downPixmap

protected final Pixmap downPixmap

emptyPixmap

protected final Pixmap emptyPixmap

xHotspot

protected final int xHotspot

yHotspot

protected final int yHotspot

visible

protected boolean visible

Constructor Detail

CustomCursor

public CustomCursor(Pixmap upPixmap,
                    Pixmap downPixmap,
                    int xHotspot,
                    int yHotspot)

Constructor

Parameters:

upPixmap - The image to use in the mouse button up state

downPixmap - The image to use in the mouse button down state

xHotspot - The x location of the hotspot pixel within the cursor image (origin top-left corner)

yHotspot - The y location of the hotspot pixel within the cursor image (origin top-left corner)

Method Detail

updateCursorVisibility

protected abstract void updateCursorVisibility()

getUpPixmap

public Pixmap getUpPixmap()

getDownPixmap

public Pixmap getDownPixmap()

getEmptyPixmap

public Pixmap getEmptyPixmap()

getxHotspot

public int getxHotspot()

getyHotspot

public int getyHotspot()

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)