Package com.simsilica.lemur.input

Enum Class InputState

java.lang.Object

java.lang.Enum<InputState>

com.simsilica.lemur.input.InputState

All Implemented Interfaces:

Serializable, Comparable<InputState>, Constable

public enum InputState
extends Enum<InputState>

Represents a trinary input state (0, 1, -1). Normal on/off control inputs are mapped to InputState.Positive and InputState.Off. When analog axis inputs are translated into states they can be any of the InputState values depending on if the analog value is positive, negative, or zero. Also, on/off inputs can be biased to be InputState.Negative instead of InputState.Positive.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Negative
Off
Positive

Method Summary

Modifier and Type	Method	Description
int	asNumber()
static InputState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InputState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Off

public static final InputState Off

Positive

public static final InputState Positive

Negative

public static final InputState Negative

Method Details

values

public static InputState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static InputState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

asNumber

public int asNumber()