com.simsilica.lemur.input

Enum InputState

java.lang.Object

java.lang.Enum<InputState>

com.simsilica.lemur.input.InputState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InputState>

public enum InputState
extends java.lang.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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Negative
Off
Positive

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Off

public static final InputState Off

Positive

public static final InputState Positive

Negative

public static final InputState Negative

Method Detail

values

public static InputState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InputState c : InputState.values())
    System.out.println(c);

Returns:

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

valueOf

public static InputState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

asNumber

public int asNumber()