de.golfgl.gdx.controllers.mapping

Class ControllerMappings

java.lang.Object

de.golfgl.gdx.controllers.mapping.ControllerMappings

public class ControllerMappings
extends java.lang.Object

Created by Benjamin Schulte on 04.11.2017.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerMappings.ControllerAxis
static class	ControllerMappings.ControllerButton
static class	ControllerMappings.ControllerInput
protected class	ControllerMappings.MappedInput A single input mapping definition for one ConfiguredInput and one Controller
protected class	ControllerMappings.MappedInputs Input mappings for a single controller.
static class	ControllerMappings.RecordResult

Field Summary

Fields

Modifier and Type	Field and Description
float	analogToDigitalTreshold
static java.lang.String	LOG_TAG
float	maxAcceptedAnalogValue some Gamepads report analog axis from .997 to 1.03...

Constructor Summary

Constructors

Constructor and Description
ControllerMappings()

Method Summary

Modifier and Type	Method and Description
ControllerMappings	addConfiguredInput(ConfiguredInput configuredInput)
void	commitConfig() call this when configuration is done
boolean	fillFromJson(com.badlogic.gdx.utils.JsonValue json)
protected ControllerMappings.MappedInputs	getControllerMapping(com.badlogic.gdx.controllers.Controller controller)
boolean	getDefaultMapping(ControllerMappings.MappedInputs defaultMapping, com.badlogic.gdx.controllers.Controller controller) use this method to define a default mapping for your controllers.
void	recordButtonsToIgnoreForMapping(com.badlogic.gdx.controllers.Controller controller) Some Controllers might have buttons or axis that are broken and always report a value.
ControllerMappings.RecordResult	recordMapping(com.badlogic.gdx.controllers.Controller controller, int configuredInputId) Record a mapping.
void	resetMappings(com.badlogic.gdx.controllers.Controller controller) resets mapping for the given controller.
com.badlogic.gdx.utils.JsonValue	toJson()

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

See Also:

Constant Field Values

analogToDigitalTreshold

public float analogToDigitalTreshold

maxAcceptedAnalogValue

public float maxAcceptedAnalogValue

some Gamepads report analog axis from .997 to 1.03...

Constructor Detail

ControllerMappings

public ControllerMappings()

Method Detail

toJson

public com.badlogic.gdx.utils.JsonValue toJson()

Returns:

all mappings as a json value

fillFromJson

public boolean fillFromJson(com.badlogic.gdx.utils.JsonValue json)

getControllerMapping

protected ControllerMappings.MappedInputs getControllerMapping(com.badlogic.gdx.controllers.Controller controller)

getDefaultMapping

public boolean getDefaultMapping(ControllerMappings.MappedInputs defaultMapping,
                                 com.badlogic.gdx.controllers.Controller controller)

use this method to define a default mapping for your controllers.

The method is only called if mapping for the controller is needed, but not found. Use the given controller object to find out more about the controller.

Parameters:

defaultMapping - Use MappedInputs#putMapping(MappedInput) on this to define default mappings

Returns:

true if default mappings were defined and should be used

addConfiguredInput

public ControllerMappings addConfiguredInput(ConfiguredInput configuredInput)

commitConfig

public void commitConfig()

call this when configuration is done

resetMappings

public void resetMappings(com.badlogic.gdx.controllers.Controller controller)

resets mapping for the given controller. Warning: already instantiated MappedController will still hold a reference to the old mapping, so be sure to refresh such references with its MappedController.refreshMappingCache(). MappedControllerAdapter is not concerned.

Parameters:

controller -

recordButtonsToIgnoreForMapping

public void recordButtonsToIgnoreForMapping(com.badlogic.gdx.controllers.Controller controller)

Some Controllers might have buttons or axis that are broken and always report a value. Call this method before you begin to record mappings to ignore all those buttons and axis.

Parameters:

controller - controller to listen to

recordMapping

public ControllerMappings.RecordResult recordMapping(com.badlogic.gdx.controllers.Controller controller,
                                                     int configuredInputId)

Record a mapping. Don't call this in every render call, although it should make no problems users won't be so fast.

Parameters:

controller - controller to listen to

configuredInputId - configured button or axis to record

Returns:

ControllerMappings.RecordResult.nothing_done if nothing was done, ControllerMappings.RecordResult.not_added if buttons were pressed but could not be added, ControllerMappings.RecordResult.need_second_button if axis was mapped to button and next call must be for an axis is the reverse button, ControllerMappings.RecordResult.not_added_need_button if is waiting for the second button but no valid was pressed ControllerMappings.RecordResult.recorded if a button mapping was added