Package com.simsilica.lemur.input

Class InputMapper.StateGroup

java.lang.Object

com.simsilica.lemur.input.InputMapper.StateGroup

All Implemented Interfaces:

InputMapper.Mapping, Comparable<InputMapper.StateGroup>

Enclosing class:

InputMapper

protected class InputMapper.StateGroup
extends Object
implements Comparable<InputMapper.StateGroup>, InputMapper.Mapping

Constructor Summary

Constructors

Constructor	Description
StateGroup(FunctionId function, double scale, Object primaryState, Object... modifiers)

Method Summary

Modifier and Type	Method	Description
boolean	areModifiersTrue()
int	compareTo(InputMapper.StateGroup other)
FunctionId	getFunction()
List<Object>	getModifiers()	Returns the additional modifier inputs that must be present for this mapping to be activated.
Object	getPrimary()
Object	getPrimaryActivator()	Returns the primary inputs that activates this mapping.
double	getScale()
double	getValue()
boolean	hasSameModifiers(Object[] mods)
boolean	isPrimary(Object state)
boolean	isTrue()
void	resetValue()
void	setScale(double scale)
String	toString()
void	updateState(InputState state)
void	updateValue(double value)

Methods inherited from class java.lang.Object

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

Constructor Details

StateGroup

public StateGroup(FunctionId function,
 double scale,
 Object primaryState,
 Object... modifiers)

Method Details

getPrimaryActivator

public Object getPrimaryActivator()

Description copied from interface: InputMapper.Mapping

Returns the primary inputs that activates this mapping.

Specified by:

getPrimaryActivator in interface InputMapper.Mapping

getModifiers

public List<Object> getModifiers()

Description copied from interface: InputMapper.Mapping

Returns the additional modifier inputs that must be present for this mapping to be activated.

Specified by:

getModifiers in interface InputMapper.Mapping

setScale

public void setScale(double scale)

Specified by:

setScale in interface InputMapper.Mapping

getScale

public double getScale()

Specified by:

getScale in interface InputMapper.Mapping

hasSameModifiers

public boolean hasSameModifiers(Object[] mods)

compareTo

public int compareTo(InputMapper.StateGroup other)

Specified by:

compareTo in interface Comparable<InputMapper.StateGroup>

getFunction

public FunctionId getFunction()

Specified by:

getFunction in interface InputMapper.Mapping

getValue

public double getValue()

updateValue

public void updateValue(double value)

updateState

public void updateState(InputState state)

resetValue

public void resetValue()

getPrimary

public Object getPrimary()

isPrimary

public boolean isPrimary(Object state)

isTrue

public boolean isTrue()

areModifiersTrue

public boolean areModifiersTrue()

toString

public String toString()

Overrides:

toString in class Object