JoystickTypes.h

/*
 *  Copyright (C) 2014-2024 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "input/InputTypes.h"

#include <set>
#include <string>


namespace KODI
{
namespace JOYSTICK
{
using FeatureName = std::string;

enum class FEATURE_TYPE
{
  UNKNOWN,
  SCALAR,
  ANALOG_STICK,
  ACCELEROMETER,
  MOTOR,
  RELPOINTER,
  ABSPOINTER,
  WHEEL,
  THROTTLE,
  KEY,
};

enum class FEATURE_CATEGORY
{
  UNKNOWN,
  FACE,
  SHOULDER,
  TRIGGER,
  ANALOG_STICK,
  ACCELEROMETER,
  HAPTICS,
  MOUSE_BUTTON,
  POINTER,
  LIGHTGUN,
  OFFSCREEN, // Virtual button to shoot light gun offscreen
  KEY, // A keyboard key
  KEYPAD, // A key on a numeric keymap, including star and pound
  HARDWARE, // A button or functionality on the console
  WHEEL,
  JOYSTICK,
  PADDLE,
};

using HAT_DIRECTION = INPUT::CARDINAL_DIRECTION;

using HAT_STATE = INPUT::INTERCARDINAL_DIRECTION;

using ANALOG_STICK_DIRECTION = INPUT::CARDINAL_DIRECTION;

using RELATIVE_POINTER_DIRECTION = INPUT::CARDINAL_DIRECTION;

enum class SEMIAXIS_DIRECTION
{
  NEGATIVE = -1, // semiaxis lies in the interval [-1.0, 0.0]
  ZERO = 0, // semiaxis is unknown or invalid
  POSITIVE = 1, // semiaxis lies in the interval [0.0, 1.0]
};

enum class WHEEL_DIRECTION
{
  NONE,
  RIGHT,
  LEFT,
};

enum class THROTTLE_DIRECTION
{
  NONE,
  UP,
  DOWN,
};

enum class INPUT_TYPE
{
  UNKNOWN,
  DIGITAL,
  ANALOG,
};

enum class PRIMITIVE_TYPE
{
  UNKNOWN = 0, // primitive has no type (invalid)
  BUTTON, // a digital button
  HAT, // one of the four direction arrows on a D-pad
  SEMIAXIS, // the positive or negative half of an axis
  MOTOR, // a rumble motor
  KEY, // a keyboard key
  MOUSE_BUTTON, // a mouse button
  RELATIVE_POINTER, // a relative pointer, such as on a mouse
};
} // namespace JOYSTICK
} // namespace KODI