DesktopInputContext.h

//
//  DesktopInputContext.h
//  avara3d
//
//  Created by Morgan Davis on 12/2/2025.
//  Copyright © 2026 Morgan K Davis. All rights reserved.
//
 
#ifndef AVARA3D_INPUT_DESKTOPINPUTCONTEXT_H
#define AVARA3D_INPUT_DESKTOPINPUTCONTEXT_H
 
#include <unordered_set>
 
#include "a3d/Math.h"
#include "a3d/input/InputContext.h"
 
namespace a3d {
 
    class DesktopInputContext : public InputContext {
 
    public:
        // [Public Types]
 
        enum class Key : int {
            Unknown      = 0,
            Space        = 32, //+
            Apostrophe   = 39, //+
            Comma        = 44, //+
            Minus        = 45,
            Period       = 46,
            Slash        = 47,
            Zero         = 48,
            One          = 49,
            Two          = 50,
            Three        = 51,
            Four         = 52,
            Five         = 53,
            Six          = 54,
            Seven        = 55,
            Eight        = 56,
            Nine         = 57,
            Semicolon    = 59,
            Equal        = 61,
            A            = 65,
            B            = 66,
            C            = 67,
            D            = 68,
            E            = 69,
            F            = 70,
            G            = 71,
            H            = 72,
            I            = 73,
            J            = 74,
            K            = 75,
            L            = 76,
            M            = 77,
            N            = 78,
            O            = 79,
            P            = 80,
            Q            = 81,
            R            = 82,
            S            = 83,
            T            = 84,
            U            = 85,
            V            = 86,
            W            = 87,
            X            = 88,
            Y            = 89,
            Z            = 90,
            LeftBracket  = 91,
            Backslash    = 92,
            RightBracket = 93,
            GraveAccent  = 96,
            World1       = 161, // non-US #1
            World2       = 162, // non-US #2
 
            /* Function keys */
            Escape         = 256,
            Enter          = 257,
            Tab            = 258,
            Backspace      = 259,
            Insert         = 260,
            ForwardDelete  = 261,
            Right          = 262,
            Left           = 263,
            Down           = 264,
            Up             = 265,
            PageUp         = 266,
            PageDown       = 267,
            Home           = 268,
            End            = 269,
            CapsLock       = 280,
            ScrollLock     = 281,
            NumLock        = 282,
            PrintScreen    = 283,
            Pause          = 284,
            F1             = 290,
            F2             = 291,
            F3             = 292,
            F4             = 293,
            F5             = 294,
            F6             = 295,
            F7             = 296,
            F8             = 297,
            F9             = 298,
            F10            = 299,
            F11            = 300,
            F12            = 301,
            F13            = 302,
            F14            = 303,
            F15            = 304,
            F16            = 305,
            F17            = 306,
            F18            = 307,
            F19            = 308,
            F20            = 309,
            F21            = 310,
            F22            = 311,
            F23            = 312,
            F24            = 313,
            F25            = 314,
            Keypad0        = 320,
            Keypad1        = 321,
            Keypad2        = 322,
            Keypad3        = 323,
            Keypad4        = 324,
            Keypad5        = 325,
            Keypad6        = 326,
            Keypad7        = 327,
            Keypad8        = 328,
            Keypad9        = 329,
            KeypadDecimal  = 330,
            KeypadDivide   = 331,
            KeypadMultiply = 332,
            KeypadSubtract = 333,
            KeypadAdd      = 334,
            KeypadEnter    = 335,
            KeypadEqual    = 336,
            LeftShift      = 340,
            LeftControl    = 341,
            LeftAlt        = 342,
            LeftSuper      = 343,
            RightShift     = 344,
            RightControl   = 345,
            RightAlt       = 346,
            RightSuper     = 347,
            Menu           = 348
        };
 
        enum class MouseButton : int {
            One   = 0,
            Two   = 1,
            Three = 2,
            Four  = 3,
            Five  = 4,
            Six   = 5,
            Seven = 6,
            Eight = 7
        };
 
        // [Public Lifecycle Functions]
 
        DesktopInputContext();
        virtual ~DesktopInputContext() = 0;
 
        DesktopInputContext(const DesktopInputContext& other)                       = delete;
        DesktopInputContext&            operator=(const DesktopInputContext& other) = delete;
 
        // [Public Member Functions]
 
        bool                            keyDown(Key key);
 
        bool                            mouseButtonDown(MouseButton button);
 
        bool                            keyPressed(Key key);
 
        bool                            mouseButtonPressed(MouseButton button);
 
        bool                            keyReleased(Key key);
 
        bool                            mouseButtonReleased(MouseButton button);
 
        std::unordered_set<Key>         keysDown(); // keys currently down
 
        std::unordered_set<MouseButton> mouseButtonsDown(); // mouse buttons currently down
 
        // TODO: rework theese.
 
        // only reports keys down for one query until they are released
        std::unordered_set<Key>         keysPressed();
 
        // only reports mouse buttons down for one query until they are released
        std::unordered_set<MouseButton> mouseButtonsPressed();
 
        // current pointer position in logical viewport coordinates
        const math::vec2&               mousePosition() const;
 
        // pointer displacement observed during the current input update
        const math::vec2&               mousePositionDelta() const;
 
        // scroll displacement observed during the current input update
        const math::vec2&               mouseScrollWheelDelta() const;
 
        // [InputContext Internal Member Functions]
 
        void                            update(const UpdateInfo& info) override;
 
        // [Internal Member Functions]
 
        virtual void                    rebaseMouseMotion();
        void                            releaseAllInputs();
 
    protected:
        // [Protected Member Variables]
 
        std::unordered_set<Key>         _keysDown;
        std::unordered_set<MouseButton> _mouseButtonsDown;
        std::unordered_set<Key>         _keysPressed;
        std::unordered_set<Key>         _keysPressedCleared;
        std::unordered_set<MouseButton> _mouseButtonsPressed;
        std::unordered_set<MouseButton> _mouseButtonsPressedCleared;
        std::unordered_set<Key>         _keysReleased;
        std::unordered_set<MouseButton> _mouseButtonsReleased;
        math::vec2                      _mousePosition;
        math::vec2                      _mousePositionDelta;
        math::vec2                      _pendingMousePositionDelta;
        math::vec2                      _mouseScrollWheelDelta;
        math::vec2                      _pendingMouseScrollWheelDelta;
    };
 
}
 
#endif // AVARA3D_INPUT_DESKTOPINPUTCONTEXT_H