gh-89: implement ui elements in imgui backend

Author: EgorOrachyov

.github/workflows/build.yml

@@ -78,14 +78,14 @@ jobs:
       - name: Install glew dependencies
         shell: bash
         run: |
-          sudo apt-get install -y libgl1-mesa-dri libgl1-mesa-glx libgl1-mesa-dev
+          sudo apt-get install -y libgl1-mesa-dri libgl1 libglx-mesa0 libgl1-mesa-dev
           sudo apt-get install -y libxmu-dev libxi-dev libgl-dev libglx-dev
           sudo apt-get install -y libx11-dev
 
       - name: Install openal dependencies
         shell: bash
         run: |
-          sudo apt-get install -y libpulse-dev portaudio19-dev libasound2-dev libjack-dev libpipewire-0.2-dev qtbase5-dev libdbus-1-dev
+          sudo apt-get install -y libpulse-dev portaudio19-dev libasound2-dev libjack-dev qtbase5-dev libdbus-1-dev
 
       - name: Install Vulkan SDK
         uses: humbletim/setup-vulkan-sdk@v1.2.1

deps/imgui/imgui.h

@@ -576,6 +576,7 @@ namespace ImGui
     // - ImageButton() draws a background based on regular Button() color + optionally an inner background if specified.
     IMGUI_API void          Image(ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& tint_col = ImVec4(1, 1, 1, 1), const ImVec4& border_col = ImVec4(0, 0, 0, 0));
     IMGUI_API bool          ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));
+    IMGUI_API bool          ImageButtonWithLabel(const char* str_id, const char* label, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0 = ImVec2(0, 0), const ImVec2& uv1 = ImVec2(1, 1), const ImVec4& bg_col = ImVec4(0, 0, 0, 0), const ImVec4& tint_col = ImVec4(1, 1, 1, 1));
 
     // Widgets: Combo Box (Dropdown)
     // - The BeginCombo()/EndCombo() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() items.

deps/imgui/imgui_internal.h

@@ -3703,6 +3703,7 @@ namespace ImGui
     IMGUI_API bool          ButtonEx(const char* label, const ImVec2& size_arg = ImVec2(0, 0), ImGuiButtonFlags flags = 0);
     IMGUI_API bool          ArrowButtonEx(const char* str_id, ImGuiDir dir, ImVec2 size_arg, ImGuiButtonFlags flags = 0);
     IMGUI_API bool          ImageButtonEx(ImGuiID id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col, ImGuiButtonFlags flags = 0);
+    IMGUI_API bool          ImageButtonWithLabelEx(ImGuiID id, const char* label, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col, ImGuiButtonFlags flags = 0);
     IMGUI_API void          SeparatorEx(ImGuiSeparatorFlags flags, float thickness = 1.0f);
     IMGUI_API void          SeparatorTextEx(ImGuiID id, const char* label, const char* label_end, float extra_width);
     IMGUI_API bool          CheckboxFlags(const char* label, ImS64* flags, ImS64 flags_value);

deps/imgui/imgui_widgets.cpp

@@ -1111,6 +1111,49 @@ bool ImGui::ImageButtonEx(ImGuiID id, ImTextureID user_texture_id, const ImVec2&
     return pressed;
 }
 
+bool ImGui::ImageButtonWithLabelEx(ImGuiID id, const char* label, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col, ImGuiButtonFlags flags)
+{
+    ImGuiContext& g = *GImGui;
+    const ImGuiStyle& style = g.Style;
+    ImGuiWindow* window = GetCurrentWindow();
+    if (window->SkipItems)
+        return false;
+
+    const ImVec2 padding = g.Style.FramePadding;
+    const ImVec2 label_size = CalcTextSize(label, NULL, true);
+    const float label_padding = label_size.x > 0 ? style.ItemInnerSpacing.x : 0.0f;
+    const ImVec2 bb_size = ImVec2(
+            image_size.x + label_padding + label_size.x + padding.x * 2.0f, 
+            ImMax(image_size.y, label_size.y) + padding.y * 2.0f); 
+
+    const ImRect bb(window->DC.CursorPos, window->DC.CursorPos + bb_size);
+    ItemSize(bb);
+    if (!ItemAdd(bb, id))
+        return false;
+
+    bool hovered, held;
+    bool pressed = ButtonBehavior(bb, id, &hovered, &held, flags);
+
+    const ImRect bb_image(
+            bb.Min + ImVec2(padding.x, (bb_size.y - image_size.y) * 0.5f), 
+            bb.Min + ImVec2(padding.x + image_size.x, (bb_size.y - image_size.y) * 0.5f + image_size.y));
+
+    const ImRect bb_text(
+            bb.Min + ImVec2(padding.x + image_size.x + label_padding, (bb_size.y - label_size.y) * 0.5f), 
+            bb.Min + ImVec2(padding.x + image_size.x + label_padding + label_size.x, (bb_size.y - label_size.y) * 0.5f + label_size.y));        
+
+    // Render
+    const ImU32 col = GetColorU32((held && hovered) ? ImGuiCol_ButtonActive : hovered ? ImGuiCol_ButtonHovered : ImGuiCol_Button);
+    RenderNavCursor(bb, id);
+    RenderFrame(bb.Min, bb.Max, col, true, ImClamp((float)ImMin(padding.x, padding.y), 0.0f, g.Style.FrameRounding));
+    if (bg_col.w > 0.0f)
+        window->DrawList->AddRectFilled(bb_image.Min, bb_image.Max, GetColorU32(bg_col));
+    window->DrawList->AddImage(user_texture_id, bb_image.Min, bb_image.Max, uv0, uv1, GetColorU32(tint_col));
+    RenderTextClipped(bb_text.Min, bb_text.Max, label, NULL, &label_size, style.ButtonTextAlign, &bb);
+
+    return pressed;
+}
+
 // - ImageButton() adds style.FramePadding*2.0f to provided size. This is in order to facilitate fitting an image in a button.
 // - ImageButton() draws a background based on regular Button() color + optionally an inner background if specified. (#8165) // FIXME: Maybe that's not the best design?
 bool ImGui::ImageButton(const char* str_id, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col)
@@ -1123,6 +1166,16 @@ bool ImGui::ImageButton(const char* str_id, ImTextureID user_texture_id, const I
     return ImageButtonEx(window->GetID(str_id), user_texture_id, image_size, uv0, uv1, bg_col, tint_col);
 }
 
+bool ImGui::ImageButtonWithLabel(const char* str_id, const char* label, ImTextureID user_texture_id, const ImVec2& image_size, const ImVec2& uv0, const ImVec2& uv1, const ImVec4& bg_col, const ImVec4& tint_col)
+{
+    ImGuiContext& g = *GImGui;
+    ImGuiWindow* window = g.CurrentWindow;
+    if (window->SkipItems)
+        return false;
+
+    return ImageButtonWithLabelEx(window->GetID(str_id), label, user_texture_id, image_size, uv0, uv1, bg_col, tint_col);
+}
+
 #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
 // Legacy API obsoleted in 1.89. Two differences with new ImageButton()
 // - old ImageButton() used ImTextureID as item id (created issue with multiple buttons with same image, transient texture id values, opaque computation of ID)

editor/code/window/edt_main_window.hpp

@@ -28,7 +28,6 @@
 #pragma once
 
 #include "platform/window.hpp"
-#include "ui/ui_elements.hpp"
 
 namespace wmoge {
 
@@ -37,8 +36,7 @@ namespace wmoge {
         EdtMainWindow(Ref<Window> window);
 
     private:
-        Ref<UiMainWindow> m_ui_window;
-        Ref<Window>       m_window;
+        Ref<Window> m_window;
     };
 
 }// namespace wmoge

engine/code/engine.hpp

@@ -227,11 +227,16 @@
 #include "system/plugin.hpp"
 #include "system/plugin_manager.hpp"
 
+#include "ui/ui_bars.hpp"
+#include "ui/ui_containers.hpp"
+#include "ui/ui_content.hpp"
+#include "ui/ui_controls.hpp"
 #include "ui/ui_defs.hpp"
 #include "ui/ui_element.hpp"
-#include "ui/ui_elements.hpp"
-#include "ui/ui_factory.hpp"
+#include "ui/ui_inputs.hpp"
 #include "ui/ui_manager.hpp"
 #include "ui/ui_style.hpp"
+#include "ui/ui_views.hpp"
+#include "ui/ui_window.hpp"
 
 #include "game/game_manager.hpp"

engine/code/ui/ui_attribute.hpp

@@ -41,8 +41,24 @@ namespace wmoge {
         UiAttribute() = default;
         UiAttribute(T value) : m_value(std::move(value)) {}
 
-        void     set(T value) { m_value = std::move(value); }
-        const T& get() const { return m_value; }
+        UiAttribute& operator=(const T& value) {
+            m_value = value;
+            return *this;
+        }
+
+        UiAttribute& operator=(T&& value) {
+            m_value = std::move(value);
+            return *this;
+        }
+
+        void set(T value) { m_value = std::move(value); }
+
+        operator T() const { return m_value; }
+
+        [[nodiscard]] const T& get() const { return m_value; }
+        [[nodiscard]] T&       get() { return m_value; }
+        [[nodiscard]] const T* get_ptr() const { return &m_value; }
+        [[nodiscard]] T*       get_ptr() { return &m_value; }
 
     protected:
         T m_value;
@@ -51,32 +67,46 @@ namespace wmoge {
     template<typename T>
     class UiAttributeList : public UiAttribute<std::vector<T>> {
     public:
+        using UiAttribute<std::vector<T>>::m_value;
+
         void add_element(T element) { m_value.push_back(std::move(element)); }
     };
 
     template<typename T>
     class UiAttributeOpt : public UiAttribute<std::optional<T>> {
     public:
+        using UiAttribute<std::optional<T>>::m_value;
+        using UiAttribute<std::optional<T>>::operator=;
+
         bool     has_value() const { return m_value.has_value(); }
         const T& value() const { return m_value.value(); }
+        void     reset() { m_value.reset(); }
     };
 
     template<typename T>
     class UiEvent : public UiAttribute<T> {
     public:
-        void has_callback() const { return m_value; }
+        using UiAttribute<T>::m_value;
+        using UiAttribute<T>::operator=;
+
+        bool has_callback() const { return (bool) m_value; }
     };
 
     template<typename T>
     class UiSlot : public UiAttribute<Ref<T>> {
     public:
+        using UiAttribute<Ref<T>>::m_value;
+        using UiAttribute<Ref<T>>::operator=;
+
         bool has_value() const { return m_value; }
     };
 
     template<typename T>
     class UiSlots : public UiAttribute<std::vector<T>> {
     public:
-        T&                  add_slot() { m_value.emplace_back(); }
+        using UiAttribute<std::vector<T>>::m_value;
+
+        T&                  add_slot() { return m_value.emplace_back(); }
         array_view<const T> get_slots() const { return m_value; }
     };
 

…ine/plugins/imgui/code/imgui_element.hpp engine/code/ui/ui_bars.hppengine/plugins/imgui/code/imgui_element.hpp renamed to engine/code/ui/ui_bars.hpp engine/plugins/imgui/code/imgui_element.hpp renamed to engine/code/ui/ui_bars.hpp

@@ -27,51 +27,48 @@
 
 #pragma once
 
-#include <functional>
+#include "ui/ui_attribute.hpp"
+#include "ui/ui_element.hpp"
 
 namespace wmoge {
 
-    class ImguiManager;
-
     /**
-     * @class ImguiProcessContext
-     * @brief Context for imgui 'draw' ui elements pass
+     * @class UiMenuBar
+     * @brief
      */
-    class ImguiProcessContext {
+    class UiMenuBar : public UiElement {
     public:
-        ImguiProcessContext() = default;
+        UiMenuBar() : UiElement(UiElementType::MenuBar) {}
 
-        void add_action(std::function<void()> action);
-        void exec_actions();
+        using Slot = UiSlot<UiSubElement>;
 
-    private:
-        std::vector<std::function<void()>> m_actions;
+        UiSlots<Slot> children;
     };
 
     /**
-     * @class ImguiElement
-     * @brief Base class for all imgui backend ui elements
+     * @class UiToolBar
+     * @brief
      */
-    class ImguiElement {
+    class UiToolBar : public UiElement {
     public:
-        ImguiElement(ImguiManager* manager);
-        virtual ~ImguiElement() = default;
+        UiToolBar() : UiElement(UiElementType::ToolBar) {}
 
-        virtual void process(ImguiProcessContext& context) {}
+        using Slot = UiSlot<UiSubElement>;
 
-    protected:
-        ImguiManager* m_manager;
+        UiSlots<Slot> children;
     };
 
     /**
-     * @class ImguiElementBase
-     * @brief Helper class to implement ui element
+     * @class UiStatusBar
+     * @brief
      */
-    template<typename UiBaseClass>
-    class ImguiElementBase : public UiBaseClass, public ImguiElement {
+    class UiStatusBar : public UiElement {
     public:
-        ImguiElementBase(ImguiManager* manager) : ImguiElement(manager) {}
-        ~ImguiElementBase() override = default;
+        UiStatusBar() : UiElement(UiElementType::StatusBar) {}
+
+        using Slot = UiSlot<UiSubElement>;
+
+        UiSlots<Slot> children;
     };
 
 }// namespace wmoge