UIEvent.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "UIUtility.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Flags.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Variant.hpp"
 
#include "CeresEngine/Input/InputEvent.hpp"
 
namespace CeresEngine {
    class UIWindow;
 
    enum class UIEventType {
        LeftMouseDown,
 
        LeftMouseUp,
 
        RightMouseDown,
 
        RightMouseUp,
 
        MouseMoved,
 
        LeftMouseDragged,
 
        RightMouseDragged,
 
        MouseEntered,
 
        MouseExited,
 
        OtherMouseDown,
 
        OtherMouseUp,
 
        OtherMouseDragged,
 
        KeyDown,
 
        KeyUp,
 
        ScrollWheel,
 
        FlagsChanged
    };
 
    enum class UIModifierKey : UInt16 {
        CapsLock = UInt16(ModifierButton::CapsLock),
 
        Shift = UInt16(ModifierButton::Shift),
 
        Control = UInt16(ModifierButton::Control),
 
        Option = UInt16(ModifierButton::Alt),
 
        Command = UInt16(ModifierButton::Super),
 
        NumericPad,
 
        Help,
 
        Function
    };
 
    using UIModifierKeys = Flags<UIModifierKey>;
    CE_FLAGS_OPERATORS(UIModifierKey);
 
    struct UIEvent {
        UIEventType type;
 
        double timestamp = 0.0;
 
        UIWindow* window = nullptr;
 
        UIModifierKeys modifiers = {};
    };
 
    struct UIKeyEvent : public UIEvent {
        String characters;
 
        String charactersIgnoringModifiers;
 
        bool isRepeat = false;
 
        UInt16 keyCode = 0;
    };
 
    struct UIMouseEvent : public UIEvent {
        UIPoint locationInWindow;
 
        UInt32 buttonNumber = 0;
 
        UInt32 clickCount = 0;
 
        UIPoint delta;
    };
 
    class AnyUIEvent : public Variant<UIKeyEvent, UIMouseEvent> {
        using super = Variant<UIKeyEvent, UIMouseEvent>;
 
    public:
        using super::super;
 
    public:
        [[nodiscard]] bool isKeyEvent() const noexcept { return super::is<UIKeyEvent>(); }
 
        [[nodiscard]] const UIKeyEvent& asKeyEvent() const noexcept { return super::as<UIKeyEvent>(); }
 
        [[nodiscard]] UIKeyEvent& asKeyEvent() noexcept { return super::as<UIKeyEvent>(); }
 
        [[nodiscard]] bool isMouseEvent() const noexcept { return super::is<UIMouseEvent>(); }
 
        [[nodiscard]] const UIMouseEvent& asMouseEvent() const noexcept { return super::as<UIMouseEvent>(); }
 
        [[nodiscard]] UIMouseEvent& asMouseEvent() noexcept { return super::as<UIMouseEvent>(); }
 
    };
 
} // namespace CeresEngine