com.bonzaiengine.io.input

Class GenericInput

java.lang.Object

com.bonzaiengine.io.input.GenericInput

All Implemented Interfaces:

FocusListener, KeyListener, MouseListener, MouseMotionListener, IInput

public class GenericInput
extends java.lang.Object
implements IInput, KeyListener, MouseListener, MouseMotionListener, FocusListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Point[]	pointerDragInput
protected Point	pointerInput
protected Point	pointerMoveInput

Constructor Summary

Constructors

Constructor and Description
GenericInput()
GenericInput(int keyCodeStart, int keyCodeEnd, int numButtons)

Method Summary

Modifier and Type	Method and Description
void	doMouseMove(MouseEvent e, boolean drag)
void	focusGained(FocusEvent e)
void	focusLost(FocusEvent e)
Point	getPointer()
Point	getPointerDrag(int buttonIndex)
Point	getPointerMove()
byte	isButtonClicked(int index)
float	isButtonPressed(int index)
boolean	isButtonReleased(int index)
byte	isKeyClicked(int index)
float	isKeyPressed(int index)
boolean	isKeyReleased(int index)
boolean	isPointerLocked() Optional
boolean	keyPressed(KeyEvent e)
boolean	keyReleased(KeyEvent e)
void	lockPointer(Point pointerLockPosition) Optional
boolean	mouseClicked(MouseEvent e)
boolean	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
boolean	mouseMoved(MouseEvent e)
boolean	mousePressed(MouseEvent e)
boolean	mouseReleased(MouseEvent e)
void	readInput() Update (call it once per frame).

Methods inherited from class java.lang.Object

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

Field Detail

pointerInput

protected final Point pointerInput

pointerMoveInput

protected final Point pointerMoveInput

pointerDragInput

protected final Point[] pointerDragInput

Constructor Detail

GenericInput

public GenericInput()

GenericInput

public GenericInput(int keyCodeStart,
                    int keyCodeEnd,
                    int numButtons)

Parameters:

keyCodeStart - key code (see KeyEvent) of the first character to record, suggested value: 0.

keyCodeEnd - key code (see KeyEvent) of the last character to record, suggested value: 255.

numButtons - number of buttons to record, suggested value: 3.

See Also:

KeyEvent

Method Detail

readInput

public void readInput()

Description copied from interface: IInput

Update (call it once per frame).

Specified by:

readInput in interface IInput

lockPointer

public void lockPointer(Point pointerLockPosition)

Description copied from interface: IInput

Optional

Specified by:

lockPointer in interface IInput

isPointerLocked

public boolean isPointerLocked()

Description copied from interface: IInput

Optional

Specified by:

isPointerLocked in interface IInput

Returns:

true if the pointer is locked with IInput.lockPointer(Point)

mouseClicked

public final boolean mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mousePressed

public final boolean mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseReleased

public final boolean mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseEntered

public final void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

Parameters:

e - the MouseEvent

mouseExited

public final void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

Parameters:

e - the MouseEvent

mouseDragged

public final boolean mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

mouseMoved

public final boolean mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Parameters:

e - the MouseEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

doMouseMove

public final void doMouseMove(MouseEvent e,
                              boolean drag)

keyPressed

public final boolean keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

Parameters:

e - the KeyEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

keyReleased

public final boolean keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

Parameters:

e - the KeyEvent

Returns:

usually false, or returns true to indicates the event has been caught and to stop further propagation

focusGained

public final void focusGained(FocusEvent e)

Specified by:

focusGained in interface FocusListener

focusLost

public final void focusLost(FocusEvent e)

Specified by:

focusLost in interface FocusListener

getPointer

public Point getPointer()

Specified by:

getPointer in interface IInput

Returns:

the pointer position

getPointerMove

public Point getPointerMove()

Specified by:

getPointerMove in interface IInput

Returns:

the pointer move displacement

getPointerDrag

public Point getPointerDrag(int buttonIndex)

Specified by:

getPointerDrag in interface IInput

Returns:

the pointer drag displacement

isKeyPressed

public final float isKeyPressed(int index)

Specified by:

isKeyPressed in interface IInput

Parameters:

index - the key id (use KeyEvent.VK_)

Returns:

a floating point value in the range [0.;1.0]. 0 means not pressed, 1 means fully pressed.

isKeyReleased

public final boolean isKeyReleased(int index)

Specified by:

isKeyReleased in interface IInput

Parameters:

index - the key id (use KeyEvent.VK_)

Returns:

true if just released

isKeyClicked

public final byte isKeyClicked(int index)

Specified by:

isKeyClicked in interface IInput

Parameters:

index - the key id (use KeyEvent.VK_)

Returns:

the number of click events

isButtonPressed

public final float isButtonPressed(int index)

Specified by:

isButtonPressed in interface IInput

Parameters:

index - the button id, starting from 0

Returns:

a floating point value in the range [0.;1.0]. 0 means not pressed, 1 means fully pressed.

isButtonReleased

public final boolean isButtonReleased(int index)

Specified by:

isButtonReleased in interface IInput

Parameters:

index - the button id, starting from 0

Returns:

true if just released

isButtonClicked

public final byte isButtonClicked(int index)

Specified by:

isButtonClicked in interface IInput

Parameters:

index - the button id, starting from 0

Returns:

the number of click events