ftc/com.rowanmcalpin.nextftc.ftc.gamepad/Joystick

Joystick

class Joystick(xAxisValue: () -> Float, yAxisValue: () -> Float, buttonValue: () -> Boolean, horizontalThreshold: Float = 0.0f, verticalThreshold: Float = 0.0f, reverseVertical: Boolean = true) : Control

A joystick has 2 JoystickAxis plus a button.

Parameters

xAxisValue

the value of the x-axis to watch

yAxisValue

the value of the y-axis to watch

buttonValue

the value of the button to watch

horizontalThreshold

the amount the horizontal axis has to be moved in either direction before it is considered 'displaced'

verticalThreshold

the amount the vertical axis has to be moved in either direction before it is considered 'displaced'

reverseVertical

by default, the y-axis of Joysticks are reversed (so pushing away from you decreases the value instead of increasing. When this is true, it will automatically correct for that.

Constructors

constructor(xAxisValue: () -> Float, yAxisValue: () -> Float, buttonValue: () -> Boolean, horizontalThreshold: Float = 0.0f, verticalThreshold: Float = 0.0f, reverseVertical: Boolean = true)

Properties

var button: Button

The Button of the joystick.

displacedCommand

var displacedCommand: (Pair<Float, Float>) -> Command

This command will be scheduled every time the joystick moves off center. Note that it receives a pair of floats; these are the x and y values.

var fallingState: Boolean

Whether the current boolean state just changed to false.

var heldCommand: (Pair<Float, Float>) -> Command

This command will be scheduled every update that the joystick isn't centered. Note that it receives a pair of floats; these are the x and y values.

var profileCurve: (Float) -> Float

Current profile curve (defaults to linear)

releasedCommand

var releasedCommand: (Pair<Float, Float>) -> Command

This command will be scheduled every time the joystick returns to center. Note that it receives a pair of floats; these are the x and y values.

var risingState: Boolean

Whether the current boolean state just changed to true.

var state: Boolean

The current boolean state of this control.

stateChangeCommand

var stateChangeCommand: (Pair<Float, Float>) -> Command

This command will be scheduled whenever the state changes. Note that it receives a pair of floats; these are the x and y values.

var stateChanged: Boolean

Whether the current boolean state just changed.

val x: Float

X-value of the joystick.

var xAxis: JoystickAxis

The JoystickAxis representing horizontal motion.

val y: Float

Y-value of the joystick. If reverseVertical is true, this will be the corrected direction.

var yAxis: JoystickAxis

The JoystickAxis representing vertical motion.

Functions

open override fun update()

Updates the current state and the rising, falling, and changed states. Further, schedules commands accordingly.