Package com.ardor3d.input

Class MouseCursor

java.lang.Object

com.ardor3d.input.MouseCursor

public class MouseCursor
extends Object

An immutable representation of a mouse cursor. A mouse cursor consists of an image and a hotspot where clicking is done.

Field Summary

Fields

Modifier and Type	Field	Description
static final MouseCursor	SYSTEM_DEFAULT	This constant is used to identify that the native operating system's default cursor should be used.

Constructor Summary

Constructors

Constructor	Description
MouseCursor(String name, Image image, int hotspotX, int hotspotY)	Instantiates a MouseCursor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getHeight()
int	getHotspotX()
int	getHotspotY()
Image	getImage()
String	getName()
int	getWidth()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_DEFAULT

public static final MouseCursor SYSTEM_DEFAULT

This constant is used to identify that the native operating system's default cursor should be used. It is not a valid mouse cursor in itself.

Constructor Details

MouseCursor

public MouseCursor(String name,
 Image image,
 int hotspotX,
 int hotspotY)

Instantiates a MouseCursor.

Parameters:

name - the name of this cursor, for debugging purposes.

image - the image that will be shown when this cursor is active.

hotspotX - the X coordinate of the clicking hotspot, 0 = left side

hotspotY - the Y coordinate of the clicking hotspot, 0 = bottom

Method Details

getName

public String getName()

getImage

public Image getImage()

getWidth

public int getWidth()

getHeight

public int getHeight()

getHotspotX

public int getHotspotX()

getHotspotY

public int getHotspotY()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object