IInputHandler.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/joysticks/JoystickTypes.h"

#include <string>

namespace KODI
{
namespace JOYSTICK
{
class IInputReceiver;

class IInputHandler
{
public:
  virtual ~IInputHandler() = default;

  virtual std::string ControllerID(void) const = 0;

  virtual bool HasFeature(const FeatureName& feature) const = 0;

  virtual bool AcceptsInput(const FeatureName& feature) const = 0;

  virtual bool OnButtonPress(const FeatureName& feature, bool bPressed) = 0;

  virtual void OnButtonHold(const FeatureName& feature, unsigned int holdTimeMs) = 0;

  virtual bool OnButtonMotion(const FeatureName& feature,
                              float magnitude,
                              unsigned int motionTimeMs) = 0;

  virtual bool OnAnalogStickMotion(const FeatureName& feature,
                                   float x,
                                   float y,
                                   unsigned int motionTimeMs) = 0;

  virtual bool OnAccelerometerMotion(const FeatureName& feature, float x, float y, float z)
  {
    return false;
  }

  virtual bool OnWheelMotion(const FeatureName& feature,
                             float position,
                             unsigned int motionTimeMs) = 0;

  virtual bool OnThrottleMotion(const FeatureName& feature,
                                float position,
                                unsigned int motionTimeMs) = 0;

  virtual void OnInputFrame() = 0;

  // Input receiver interface
  void SetInputReceiver(IInputReceiver* receiver) { m_receiver = receiver; }
  void ResetInputReceiver(void) { m_receiver = nullptr; }
  IInputReceiver* InputReceiver(void) { return m_receiver; }

private:
  IInputReceiver* m_receiver = nullptr;
};
} // namespace JOYSTICK
} // namespace KODI