cohtml.InputSystem.GamepadMapper

Abstract class describing the Unity3D Input Manager gamepad mapping to the W3C standard gamepad mapping.

Inherits from cohtml.InputSystem.GamepadBase.GamepadMap

Inherited by cohtml.InputSystem.GamepadMapGeneric, cohtml.InputSystem.GamepadMapWinPS

Public Types #

Protected Types #

Public Functions #

Protected Functions #

Public Properties #

Public Attributes #

Protected Attributes #

Additional inherited members #

Public Functions inherited from cohtml.InputSystem.GamepadBase.GamepadMap

Public Attributes inherited from cohtml.InputSystem.GamepadBase.GamepadMap

Public Types Documentation #

enum Profile #

The supported gamepad mapping profiles. Add a new one or use Other

enum Platform #

Supported OS platforms. When a gamepad from another platform is present, it should be added here. The value Unknown should always be first, and Count should always remain last.

Protected Types Documentation #

enum JSIndex #

Buttons and Axes displayed in the correct order in the array according to the W3C standard. Each number corresponds to the index in the array.

Public Functions Documentation #

function UpdateEntities #

virtual void UpdateEntities()

Updates the array of buttons and axes based on the mapping.

Reimplemented by: cohtml.InputSystem.GamepadMapWinPS.UpdateEntities

Protected Functions Documentation #

function GamepadMapper #

GamepadMapper(
    uint id,
    string name,
    int buttonsLength =16,
    int axesLength =4
)

function MapButton #

string MapButton(
    byte button
)

function MapAxis #

string MapAxis(
    byte axis
)

function UpdateButtons #

virtual void UpdateButtons()

Updates the array of buttons based on the mapping.

function UpdateDPad #

virtual void UpdateDPad(
    string mapX,
    bool isInvertedX,
    string mapY,
    bool isInvertedY
)

Most D-Pad buttons are mapped to 2 axes, but sometimes they are 4 buttons, sometimes are inverted axes, Provide a way to handle the buttons mapping.

Parameters:

• mapX Provide the horizontally mapping string
• isInvertedX “Does it indicate whether the horizontal axis is inverted?”
• mapY “Provide the vertically mapping string”
• isInvertedY Does it indicate whether the vertical axis is inverted?

function UpdateValue #

virtual void UpdateValue(
    float [] array,
    JSIndex jsIndex,
    float value
)

A helper method used by all the above methods to update the value of provided array index.

Public Property Documentation #

property ProfileType #

abstract Profile ProfileType;

Public Attributes Documentation #

variable CohtmlGamepadStr #

const string CohtmlGamepadStr = "Cohtml_Gamepad";

variable CohtmlGamepadAxisName #

readonly string CohtmlGamepadAxisName;

variable JoystickButtonName #

readonly string JoystickButtonName;

Protected Attributes Documentation #

variable m_ButtonsMap #

Dictionary< JSIndex, string > m_ButtonsMap;

variable m_AxesMap #

Dictionary< JSIndex, string > m_AxesMap;

variable m_FloatValue #

float m_FloatValue;

variable m_JsIndex #

JSIndex m_JsIndex;