Package io.github.thecsdev.tcdcommons.api.client.gui.util

Class TInputContext

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.util.TInputContext

public final class TInputContext
extends Object

Holds the information about a given user input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TInputContext.InputDiscoveryPhase	This refers to the current "phase" at which an input is being handled. Each input phase has its own unique behaviors.
static final class	TInputContext.InputKeyboardKey	Represents an input keyboard key.
static enum	TInputContext.InputType	Represents an input's type.
static @interface	TInputContext.UsedFor	Used to indicate what TInputContext.InputType a given getter method in TInputContext is supposed to be used for.

Method Summary

Modifier and Type	Method	Description
final TInputContext.InputType	getInputType()
final @Nullable TInputContext.InputKeyboardKey	getKeyboardKey()
final @Nullable Integer	getMouseButton()
final Point2D.Double	getMouseDelta()
final Point2D.Double	getMousePosition()
final Point2D.Double	getScrollAmount()
final @Nullable Character	getTypedChar()
static TInputContext	ofCharType(char character, int modifiers)	"Of character type"
static TInputContext	ofKeyboardPR(TInputContext.InputKeyboardKey key, boolean isDown)	"Of keyboard press/release".
static TInputContext	ofMouseCR(int mouseButton, boolean isDown)	"Of mouse click/release".
static TInputContext	ofMouseDrag(double mouseX, double mouseY, double deltaX, double deltaY, int mouseButton)	"Of mouse drag"
static TInputContext	ofMouseDragEnd(int mouseButton)	"Of mouse drag end" Only invoked on elements that were previously being dragged and no longer are.
static TInputContext	ofMouseMove(double mouseX, double mouseY)
static TInputContext	ofMouseScroll(double mouseX, double mouseY, double vAmount)
static TInputContext	ofMouseScroll(double mouseX, double mouseY, double hAmount, double vAmount)

Methods inherited from class java.lang.Object

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

Method Details

getInputType

public final TInputContext.InputType getInputType()

getKeyboardKey

@Nullable
public final @Nullable TInputContext.InputKeyboardKey getKeyboardKey()

getTypedChar

@Nullable
public final @Nullable Character getTypedChar()

getMouseButton

@Nullable
public final @Nullable Integer getMouseButton()

getMousePosition

@Nullable
public final Point2D.Double getMousePosition()

getMouseDelta

@Nullable
public final Point2D.Double getMouseDelta()

getScrollAmount

@Nullable
public final Point2D.Double getScrollAmount()

ofKeyboardPR

public static TInputContext ofKeyboardPR(TInputContext.InputKeyboardKey key,
 boolean isDown)

"Of keyboard press/release".

Parameters:

key - The TInputContext.InputKeyboardKey that was pressed or released.

isDown - true = TInputContext.InputType.KEY_PRESS; false = TInputContext.InputType.KEY_RELEASE.

ofCharType

public static TInputContext ofCharType(char character,
 int modifiers)

"Of character type"

Parameters:

character - The Character the user typed.

modifiers - The character modifiers.

ofMouseCR

public static TInputContext ofMouseCR(int mouseButton,
 boolean isDown)

"Of mouse click/release".

Parameters:

mouseButton - The mouse button that was clicked or released.

isDown - true = TInputContext.InputType.MOUSE_PRESS; false = TInputContext.InputType.MOUSE_RELEASE

ofMouseMove

public static TInputContext ofMouseMove(double mouseX,
 double mouseY)

ofMouseDrag

public static TInputContext ofMouseDrag(double mouseX,
 double mouseY,
 double deltaX,
 double deltaY,
 int mouseButton)

"Of mouse drag"

Parameters:

mouseButton - The mouse button that was clicked when the dragging first started.

ofMouseDragEnd

public static TInputContext ofMouseDragEnd(int mouseButton)

"Of mouse drag end"
Only invoked on elements that were previously being dragged and no longer are.

Parameters:

mouseButton - The mouse button that was clicked when the dragging first started.

ofMouseScroll

public static TInputContext ofMouseScroll(double mouseX,
 double mouseY,
 double vAmount)

ofMouseScroll

public static TInputContext ofMouseScroll(double mouseX,
 double mouseY,
 double hAmount,
 double vAmount)