polyui/org.polyfrost.polyui.event/InputManager

InputManager

class InputManager(master: Inputtable?, var keyBinder: KeyBinder?, settings: Settings)

InputManager

Handles input events and passes them to the correct components/layouts.

Parameters

master

the layout to create this event manager for. marked as internal as should not be accessed.

keyBinder

the key binder to use for this event manager. marked as internal as should not be accessed.

Constructors

constructor(master: Inputtable?, keyBinder: KeyBinder?, settings: Settings)

Properties

var focused: Inputtable?

var keyBinder: KeyBinder?

@get:JvmName(name = "getKeyModifiers")

val keyModifiers: Modifiers

@ApiStatus.Internal

the current key modifiers (raw).

var mouseDown: Boolean

weather or not the left button/primary click is DOWN (aka repeating)

var mouseOver: Inputtable?

var mouseX: Float

var mouseY: Float

Functions

fun addModifier(modifier: Byte)

add a modifier to the current keyModifiers.

fun clearModifiers()

Clear the current keyModifiers.

fun dispatch(event: Event, bindable: Boolean = false, to: Inputtable? = mouseOver): Boolean

Dispatch an event to the provided component.

@ApiStatus.Internal

fun drop(it: Inputtable? = null)

Drop the current mouse over component.

fun filesDropped(files: Array<Path>)

Call this method when files are dropped onto this window. The Event.Focused.FileDrop is then dispatched to the currently focused component.

fun focus(focusable: Inputtable?): Boolean

Sets the focus to the specified focusable element, throwing an exception if the provided element is not focusable.

fun keyDown(code: Int)

This method should be called when a non-representable key is pressed.

fun keyDown(key: Keys)

This method should be called when a non-printable, but representable key is pressed.

fun keyTyped(key: Char)

This method should be called when a printable key is typed. This key should be mapped to the user's keyboard layout!

fun keyUp(code: Int)

This method should be called when a non-representable key is released.

fun keyUp(key: Keys)

This method should be called when a non-printable, but representable key is released.

fun mouseMoved(x: Float, y: Float)

call this function to update the mouse position.

fun mousePressed(button: Int)

fun mouseReleased(button: Int)

call this function when a mouse button is released.

fun mouseScrolled(amountX: Float, amountY: Float)

call this function when the mouse is scrolled.

@ApiStatus.Experimental

@Contract(pure = true)

fun rayCheck(it: Inputtable, x: Float, y: Float): Inputtable?

perform a recursive ray check on the component. Each component will be checked with Component.isEnabled, then Component.isInside, then finally Inputtable.acceptsInput before it is considered a valid candidate.

@ApiStatus.Experimental

@Contract(pure = true)

fun rayCheckUnsafe(it: Component, x: Float, y: Float): Component?

same as rayCheck, but does not check for Inputtable.acceptsInput.

fun recalculate()

force the mouse position to be updated.

fun removeModifier(modifier: Byte)

remove a modifier from the current keyModifiers.

fun safeFocus(component: Inputtable?): Boolean

try to focus a component, without throwing an exception.

fun with(master: Inputtable?): InputManager