axmol/core/base/Controller.h

/****************************************************************************
 Copyright (c) 2014-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://axmolengine.github.io/

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/

#ifndef __cocos2d_libs__CCController__
#define __cocos2d_libs__CCController__
#if (AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID || AX_TARGET_PLATFORM == AX_PLATFORM_IOS || \
     AX_TARGET_PLATFORM == AX_PLATFORM_MAC || AX_TARGET_PLATFORM == AX_PLATFORM_LINUX ||   \
     defined(_WIN32) /* win32 & winuwp */ || \
AX_TARGET_PLATFORM == AX_PLATFORM_WASM)

#    include "platform/PlatformMacros.h"
#    include <string>
#    include <vector>
#    include <unordered_map>

NS_AX_BEGIN

class ControllerImpl;
class EventListenerController;
class EventController;
class EventDispatcher;

/**
 * @addtogroup base
 * @{
 */

/**
 * @class Controller
 * @brief A Controller object represents a connected physical game controller.
 * @js NA
 */
class AX_DLL Controller
{
public:
    /**
     * Controllers' standard  key
     * Controller receives only standard key which contained within enum Key by default.
     */
    enum Key
    {
        KEY_NONE = 0,

        JOYSTICK_LEFT_X = 1000,
        JOYSTICK_LEFT_Y,
        JOYSTICK_RIGHT_X,
        JOYSTICK_RIGHT_Y,

        BUTTON_A,
        BUTTON_B,
        BUTTON_C,
        BUTTON_X,
        BUTTON_Y,
        BUTTON_Z,

        BUTTON_DPAD_UP,
        BUTTON_DPAD_DOWN,
        BUTTON_DPAD_LEFT,
        BUTTON_DPAD_RIGHT,
        BUTTON_DPAD_CENTER,

        BUTTON_LEFT_SHOULDER,
        BUTTON_RIGHT_SHOULDER,

        AXIS_LEFT_TRIGGER,
        AXIS_RIGHT_TRIGGER,

        BUTTON_LEFT_THUMBSTICK,
        BUTTON_RIGHT_THUMBSTICK,

        BUTTON_START,
        BUTTON_SELECT,

        BUTTON_PAUSE,
        KEY_MAX
    };

    /**
     * @struct KeyStatus
     *
     */
    typedef struct _keyStatus
    {
        /** A Boolean value that indicates whether the key is considered pressed. */
        bool isPressed;
        /** The value of key.This value is used in conjunction with the isPressed parameter. */
        float value;
        /** A Boolean value that indicates whether the value of key is analog.
         * If isAnalog is true, the key value might be a float from -1 to 1.
         * If isAnalog is false, the key value would be contain one number: 0 or 1.
         */
        bool isAnalog;
    } KeyStatus;

    static const int TAG_UNSET = -1;

    /**
     * Gets all Controller objects.
     */
    static const std::vector<Controller*>& getAllController() { return s_allController; }

    /**
     * Gets a Controller object with tag.
     *
     * @param tag   An identifier to find the controller.
     * @return A Controller object.
     */
    static Controller* getControllerByTag(int tag);

    /**
     * Gets a Controller object with device ID.
     *
     * @param deviceId   A unique identifier to find the controller.
     * @return A Controller object.
     */
    static Controller* getControllerByDeviceId(int deviceId);

    /**
     * Start discovering new controllers.
     *
     * @warning The API has an empty implementation on Android.
     */
    static void startDiscoveryController();

    /**
     * Stop the discovery process.
     *
     * @warning The API has an empty implementation on Android.
     */
    static void stopDiscoveryController();

    /**
     * Gets the name of this Controller object.
     */
    std::string_view getDeviceName() const { return _deviceName; }

    /**
     * Gets the Controller id.
     */
    int getDeviceId() const { return _deviceId; }

    /**
     * Indicates whether the Controller is connected.
     */
    bool isConnected() const;

    /**
     *
     */
    const KeyStatus& getKeyStatus(int keyCode);

    /**
     * Activate receives key event from external key. e.g. back,menu.
     * Controller receives only standard key which contained within enum Key by default.
     *
     * @warning The API only work on the android platform for support diversified game controller.
     *
     * @param externalKeyCode   External key code.
     * @param receive   True if external key event on this controller should be receive, false otherwise.
     */
    void receiveExternalKeyEvent(int externalKeyCode, bool receive);

    /**
     * Changes the tag that is used to identify the controller easily.
     * @param tag   A integer that identifies the controller.
     */
    void setTag(int tag) { _controllerTag = tag; }

    /**
     * Returns a tag that is used to identify the controller easily.
     *
     * @return An integer that identifies the controller.
     */
    int getTag() const { return _controllerTag; }

private:
    static std::vector<Controller*> s_allController;

    Controller();
    virtual ~Controller();

    void init();

    void onConnected();
    void onDisconnected();
    void onButtonEvent(int keyCode, bool isPressed, float value, bool isAnalog);
    void onAxisEvent(int axisCode, float value, bool isAnalog);
    void registerListeners();

    std::unordered_map<int, KeyStatus> _allKeyStatus;
    std::unordered_map<int, KeyStatus> _allKeyPrevStatus;

    std::string _deviceName;
    int _deviceId;

    int _controllerTag;

    ControllerImpl* _impl;

    EventDispatcher* _eventDispatcher;
    EventController* _connectEvent;
    EventController* _keyEvent;
    EventController* _axisEvent;

#    if (AX_TARGET_PLATFORM == AX_PLATFORM_LINUX || AX_TARGET_PLATFORM == AX_PLATFORM_WIN32)
    // FIXME: Once GLFW 3.3 is bundled with cocos2d-x, remove these unordered
    // maps. They won't be needed. We will only need to provide a mapping from
    // the GLFW gamepad key codes to the Controller::Key.

    // Attach the controller profiles from CCController-linux-win32.cpp to each
    // of the Controller variables in order to minimize profile lookup time.

    // Note: this increases memory usage unnecessarily since the same maps are
    // already stored on ControllerImpl within the static member variable
    // "s_controllerProfiles", but on these platforms the increase in memory
    // usage is negligible.  Peformance over memory optimization was
    // consciously chosen.

    std::unordered_map<int, int> _buttonInputMap;
    std::unordered_map<int, int> _axisInputMap;
#    endif

    friend class ControllerImpl;
    friend class EventListenerController;
};

// end group
/// @}

NS_AX_END
#endif
#endif /* defined(__cocos2d_libs__CCController__) */