Controls.h

// Copyright (C), UNIGINE. All rights reserved.
#pragma once

#include <editor/EditorGlobal.h>

#include <UnigineCallback.h>
#include <UnigineString.h>


namespace Editor
{

class EDITOR_API Controls final
{
public:
    enum class Context
    {
        SHARED = 0,
        EXCLUSIVE,
    };

    enum ControlFlag
    {
        MOUSE = 1 << 0,
        KEYBOARD = 1 << 1,
        WHEEL = 1 << 2,
        MODIFIER = 1 << 3,
    };

    enum class MouseWheel
    {
        NONE = 0,
        UP,
        DOWN,
        RIGHT,
        LEFT,
    };

    enum ModifierFlag
    {
        NONE = 0,
        SHIFT = 1 << 0,
        CTRL = 1 << 1,
        ALT = 1 << 2,
        CMD = 1 << 3,
        MOUSE_LEFT = 1 << 4,
        MOUSE_RIGHT = 1 << 5,
        MOUSE_MIDDLE = 1 << 6,
        MOUSE_AUX_0 = 1 << 7,
        MOUSE_AUX_1 = 1 << 8,
        MOUSE_AUX_2 = 1 << 9,
        MOUSE_AUX_3 = 1 << 10,
    };

    enum class ModifierMatch
    {
        EXACT = 0,
        PARTIAL,
    };

public:
    // Context
    using ContextActiveChecker = bool (*)(void *opaque);
    static bool createContext(const char *context_id,
        const char *title,
        ContextActiveChecker checker,
        void *opaque,
        Context context_type = Context::SHARED,
        int priority = 0);
    // It also removes all the associated controls with it.
    static bool removeContext(const char *context_id);
    static bool hasContext(const char *context_id);

    // Control
    static bool createControl(const char *control_id, const char *context_id = "global",
        int control_flags = ControlFlag::MOUSE | ControlFlag::KEYBOARD | ControlFlag::WHEEL);
    static bool removeControl(const char *control_id);
    static bool hasControl(const char *control_id);

    static bool setControlTitle(const char *control_id, const char *title);
    static bool setControlTooltip(const char *control_id, const char *tooltip);
    // 'key' can be Unigine::App::KEY_<>, or e.g. 'x'.
    static bool setControlKey(const char *control_id, int key);
    // 'button' should be Unigine::App::BUTTON_<>
    static bool setControlMouseButton(const char *control_id, int mouse_button);
    static bool setControlMouseWheel(const char *control_id, MouseWheel wheel);
    // 'modifier_flags' should be made from ModifierFlag::<>
    static bool setControlModifierFlags(const char *control_id, int modifier_flags);
    static bool setControlModifierMatch(const char *control_id, ModifierMatch modifier_match);

    static bool setControlActivatedCallback(const char *control_id, Unigine::CallbackBase *func);
    static bool setControlPressedCallback(const char *control_id, Unigine::CallbackBase *func);
    static bool setControlReleasedCallback(const char *control_id, Unigine::CallbackBase *func);

    static bool addControlFriend(const char *control_id, const char *friend_control_id);
    static bool removeControlFriend(const char *control_id, const char *friend_control_id);

    static bool isControlPressed(const char *control_id);
    static bool isControlDown(const char *control_id);
    static bool isControlUp(const char *control_id);

    static Unigine::String getControlShortcutText(const char *control_id);
};

} // namespace Editor