com.jmex.awt.input
Class AWTMouseInput

java.lang.Object
  com.jme.input.Input
      com.jme.input.MouseInput
          com.jmex.awt.input.AWTMouseInput

All Implemented Interfaces:

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

public class AWTMouseInput
extends MouseInput
implements java.awt.event.MouseListener, java.awt.event.MouseWheelListener, java.awt.event.MouseMotionListener

AWTMouseInput

Version:

$Revision: 4133 $

Author:

Joshua Slack

Field Summary

static int

WHEEL_AMP

Fields inherited from class com.jme.input.MouseInput

INPUT_AWT, INPUT_LWJGL, listeners

Constructor Summary

protected

AWTMouseInput()

Method Summary

void	clear()
void	clearButton(int buttonCode)
protected void	destroy() destroy cleans up the native mouse interface.
int	getButtonCount()
int	getButtonIndex(java.lang.String buttonName) getButtonIndex gets the button code for a given button name.
java.lang.String	getButtonName(int buttonIndex) getButtonName gets the button name for a given button code.
int	getWheelDelta() getWheelDelta gets the change in the mouse wheel.
int	getWheelRotation()
int	getXAbsolute() getXAbsolute gets the absolute x axis value.
int	getXDelta() getXDelta gets the change along the x axis.
int	getYAbsolute() getYAbsolute gets the absolute y axis value.
int	getYDelta() getYDelta gets the change along the y axis.
boolean	isButtonDown(int buttonCode) isButtonDown returns true if a given button is pressed, false if it is not pressed.
boolean	isCursorVisible() isCursorVisible
boolean	isDragOnly()
boolean	isEnabled()
void	mouseClicked(java.awt.event.MouseEvent arg0)
void	mouseDragged(java.awt.event.MouseEvent arg0)
void	mouseEntered(java.awt.event.MouseEvent arg0)
void	mouseExited(java.awt.event.MouseEvent arg0)
void	mouseMoved(java.awt.event.MouseEvent arg0)
void	mousePressed(java.awt.event.MouseEvent arg0)
void	mouseReleased(java.awt.event.MouseEvent arg0)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent arg0)
void	setCursorPosition(int x, int y)
void	setCursorVisible(boolean v) setCursorVisible sets the visibility of the hardware cursor.
void	setDragOnly(boolean dragOnly)
void	setEnabled(boolean enabled)
void	setHardwareCursor(java.awt.Cursor cursor)
void	setHardwareCursor(java.net.URL file) setHardwareCursor sets the image to use for the hardware cursor.
void	setHardwareCursor(java.net.URL file, Image[] images, int[] delays, int xHotspot, int yHotspot) This method will set an animated hardware cursor.
void	setHardwareCursor(java.net.URL file, int xHotspot, int yHotspot) setHardwareCursor sets the image and hotspot position to use for the hardware cursor.
void	setRelativeDelta(java.awt.Component c)
static void	setup(java.awt.Canvas glCanvas, boolean dragOnly) Set up a canvas to fire mouse events via the input system.
void	update() Updates the state of the mouse (position and button states).

Methods inherited from class com.jme.input.MouseInput

addListener, containsListener, destroyIfInitalized, get, getListeners, getProvider, isInited, removeListener, removeListeners, setProvider, setProvider

Methods inherited from class java.lang.Object

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

Field Detail

WHEEL_AMP

public static int WHEEL_AMP

Constructor Detail

AWTMouseInput

protected AWTMouseInput()

Method Detail

destroy

protected void destroy()

Description copied from class: MouseInput

destroy cleans up the native mouse interface. Destroy is protected now - please is MouseInput.destroyIfInitalized().

Specified by:

destroy in class MouseInput

getButtonIndex

public int getButtonIndex(java.lang.String buttonName)

Description copied from class: MouseInput

getButtonIndex gets the button code for a given button name.

Specified by:

getButtonIndex in class MouseInput

Parameters:

buttonName - the name to get the code for.

Returns:

the code for the given button name.

isButtonDown

public boolean isButtonDown(int buttonCode)

Description copied from class: MouseInput

isButtonDown returns true if a given button is pressed, false if it is not pressed.

Specified by:

isButtonDown in class MouseInput

Parameters:

buttonCode - the button code to check.

Returns:

true if the button is pressed, false otherwise.

getButtonName

public java.lang.String getButtonName(int buttonIndex)

Description copied from class: MouseInput

getButtonName gets the button name for a given button code.

Specified by:

getButtonName in class MouseInput

Parameters:

buttonIndex - the code to get the name for.

Returns:

the name for the given button code.

getWheelDelta

public int getWheelDelta()

Description copied from class: MouseInput

getWheelDelta gets the change in the mouse wheel.

Specified by:

getWheelDelta in class MouseInput

Returns:

the change in the mouse wheel.

getXDelta

public int getXDelta()

Description copied from class: MouseInput

getXDelta gets the change along the x axis.

Specified by:

getXDelta in class MouseInput

Returns:

the change along the x axis.

getYDelta

public int getYDelta()

Description copied from class: MouseInput

getYDelta gets the change along the y axis.

Specified by:

getYDelta in class MouseInput

Returns:

the change along the y axis.

getXAbsolute

public int getXAbsolute()

Description copied from class: MouseInput

getXAbsolute gets the absolute x axis value.

Specified by:

getXAbsolute in class MouseInput

Returns:

the absolute x axis value.

getYAbsolute

public int getYAbsolute()

Description copied from class: MouseInput

getYAbsolute gets the absolute y axis value.

Specified by:

getYAbsolute in class MouseInput

Returns:

the absolute y axis value.

update

public void update()

Description copied from class: MouseInput

Updates the state of the mouse (position and button states). Invokes event listeners synchronously.

Specified by:

update in class MouseInput

setCursorVisible

public void setCursorVisible(boolean v)

Description copied from class: MouseInput

setCursorVisible sets the visibility of the hardware cursor.

Specified by:

setCursorVisible in class MouseInput

Parameters:

v - true turns the cursor on false turns it off

isCursorVisible

public boolean isCursorVisible()

Description copied from class: MouseInput

isCursorVisible

Specified by:

isCursorVisible in class MouseInput

Returns:

the visibility of the hardware cursor

setHardwareCursor

public void setHardwareCursor(java.net.URL file)

Description copied from class: MouseInput

setHardwareCursor sets the image to use for the hardware cursor.

Specified by:

setHardwareCursor in class MouseInput

Parameters:

file - URL to cursor image

setHardwareCursor

public void setHardwareCursor(java.awt.Cursor cursor)

setHardwareCursor

public void setHardwareCursor(java.net.URL file,
                              int xHotspot,
                              int yHotspot)

Description copied from class: MouseInput

setHardwareCursor sets the image and hotspot position to use for the hardware cursor.

Specified by:

setHardwareCursor in class MouseInput

Parameters:

file - URL to cursor image

xHotspot - Cursor X hotspot position

yHotspot - Cursor Y hotspot position

setHardwareCursor

public void setHardwareCursor(java.net.URL file,
                              Image[] images,
                              int[] delays,
                              int xHotspot,
                              int yHotspot)

Description copied from class: MouseInput

This method will set an animated hardware cursor.

Specified by:

setHardwareCursor in class MouseInput

Parameters:

file - in this method file is only used as a key for cursor cashing

images - the animation frames

delays - delays between changing each frame

xHotspot - from image left

yHotspot - from image bottom

setCursorPosition

public void setCursorPosition(int x,
                              int y)

Specified by:

setCursorPosition in class MouseInput

getWheelRotation

public int getWheelRotation()

Specified by:

getWheelRotation in class MouseInput

Returns:

absolute wheel rotation

getButtonCount

public int getButtonCount()

Specified by:

getButtonCount in class MouseInput

Returns:

number of mouse buttons

setRelativeDelta

public void setRelativeDelta(java.awt.Component c)

isEnabled

public boolean isEnabled()

Returns:

Returns the enabled.

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - The enabled to set.

isDragOnly

public boolean isDragOnly()

Returns:

Returns the dragOnly.

setDragOnly

public void setDragOnly(boolean dragOnly)

Parameters:

dragOnly - The dragOnly to set.

mouseClicked

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

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

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

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

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

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseEntered

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

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

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

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseWheelMoved

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

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

mouseDragged

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

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseMoved

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

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

setup

public static void setup(java.awt.Canvas glCanvas,
                         boolean dragOnly)

Set up a canvas to fire mouse events via the input system.

Parameters:

glCanvas - canvas that should be listened to

dragOnly - true to enable mouse input to jME only when the mouse is dragged

clear

public void clear()

Specified by:

clear in class MouseInput

clearButton

public void clearButton(int buttonCode)

Specified by:

clearButton in class MouseInput