Pursche/CanvasRenderer (#45)

* Rewrote UI rendering and made it Lua driven
* Added support for 'require' in Lua
* Better input events
* Added UI Stack
* Added various basic UI widgets implemented in Lua
* Added Loading screen support in Lua
* Updated Engine submodule

Co-authored-by: NixAJ <[email protected]>

Author: Pursche

.gitignore

@@ -31,6 +31,7 @@
 *.app
 
 build*/ 
+Build*/
 .vs/
 .vscode/
 out/

CREDITS

@@ -0,0 +1,5 @@
+We would like to extend our gratitude to the following individuals and/or organisations for being part of the process to make Novus better in one way or another.
+
+- Our Team (Pursche, Foe, Nix)
+- Our Contributors (Skarn, Elntemporel, ReynoldsCahoon, Deamon, Balkron, Skypjack, Minitbnn, Dmitry, Grim, Vblanco)
+- Eluna (https://github.com/ElunaLuaEngine/Eluna)

Source/Game-Lib/Game-Lib/Application/Application.cpp

@@ -239,6 +239,7 @@ bool Application::Init()
     ServiceLocator::SetTaskScheduler(_taskScheduler);
 
     _registries.gameRegistry = new entt::registry();
+    _registries.uiRegistry = new entt::registry();
     _registries.eventIncomingRegistry = new entt::registry();
     _registries.eventOutgoingRegistry = new entt::registry();
     ServiceLocator::SetEnttRegistries(&_registries);
@@ -262,7 +263,7 @@ bool Application::Init()
     ServiceLocator::SetEditorHandler(_editorHandler);
 
     _ecsScheduler = new ECS::Scheduler();
-    _ecsScheduler->Init(*_registries.gameRegistry);
+    _ecsScheduler->Init(_registries);
 
     ServiceLocator::SetGameConsole(new GameConsole());
 
@@ -471,7 +472,7 @@ bool Application::Tick(f32 deltaTime)
         }
     }
 
-    _ecsScheduler->Update(*_registries.gameRegistry, deltaTime);
+    _ecsScheduler->Update(_registries, deltaTime);
 
     // Handle Double Buffered Event Swap
     {

Source/Game-Lib/Game-Lib/Application/EnttRegistries.h

@@ -3,7 +3,8 @@
 
 struct EnttRegistries
 {
-    entt::registry* gameRegistry;
-    entt::registry* eventIncomingRegistry;
-    entt::registry* eventOutgoingRegistry;
+	entt::registry* gameRegistry;
+	entt::registry* uiRegistry;
+	entt::registry* eventIncomingRegistry;
+	entt::registry* eventOutgoingRegistry;
 };

Source/Game-Lib/Game-Lib/ECS/Components/UI/BoundingRect.h

@@ -0,0 +1,12 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct BoundingRect
+    {
+    public:
+        vec2 min;
+        vec2 max;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/Canvas.h

@@ -0,0 +1,11 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct Canvas
+    {
+    public:
+        
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/EventInputInfo.h

@@ -0,0 +1,33 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct EventInputInfo
+    {
+    public:
+        bool isHovered = false;
+        bool isClicked = false;
+        bool isInteractable = true;
+
+        // Templates
+        u32 onClickTemplateHash = 0;
+        u32 onHoverTemplateHash = 0;
+        u32 onUninteractableTemplateHash = 0;
+
+        // Lua Event Refs
+        i32 onMouseDownEvent = -1;
+        i32 onMouseUpEvent = -1;
+        i32 onMouseHeldEvent = -1;
+
+        i32 onHoverBeginEvent = -1;
+        i32 onHoverEndEvent = -1;
+        i32 onHoverHeldEvent = -1;
+
+        i32 onFocusBeginEvent = -1;
+        i32 onFocusEndEvent = -1;
+        i32 onFocusHeldEvent = -1;
+
+        i32 onKeyboardEvent = -1;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/Panel.h

@@ -0,0 +1,16 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct Panel
+    {
+    public:
+        u32 layer;
+
+        u32 templateIndex;
+
+        i32 gpuVertexIndex = -1;
+        i32 gpuDataIndex = -1;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/PanelTemplate.h

@@ -0,0 +1,48 @@
+#pragma once
+#include "Game-Lib/UI/Box.h"
+
+#include <Base/Math/Color.h>
+#include <Base/Types.h>
+
+#include <optional>
+
+namespace ECS::Components::UI
+{
+    struct PanelTemplate
+    {
+    public:
+        struct SetFlags
+        {
+            u8 background : 1 = 0;
+            u8 foreground : 1 = 0;
+            u8 color : 1 = 0;
+            u8 cornerRadius : 1 = 0;
+            u8 texCoords : 1 = 0;
+            u8 nineSliceCoords : 1 = 0;
+        };
+        SetFlags setFlags;
+
+        std::string background;
+        std::string foreground;
+        Color color;
+        f32 cornerRadius;
+        ::UI::Box texCoords;
+        ::UI::Box nineSliceCoords;
+
+        std::string onClickTemplate;
+        std::string onHoverTemplate;
+        std::string onUninteractableTemplate;
+
+        i32 onMouseDownEvent = -1;
+        i32 onMouseUpEvent = -1;
+        i32 onMouseHeldEvent = -1;
+
+        i32 onHoverBeginEvent = -1;
+        i32 onHoverEndEvent = -1;
+        i32 onHoverHeldEvent = -1;
+
+        i32 onFocusBeginEvent = -1;
+        i32 onFocusEndEvent = -1;
+        i32 onFocusHeldEvent = -1;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/Text.h

@@ -0,0 +1,22 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct Text
+    {
+    public:
+        std::string text;
+        u32 layer;
+
+        u32 templateIndex;
+
+        i32 gpuVertexIndex = -1;
+        i32 gpuDataIndex = -1;
+
+        i32 numCharsNonWhitespace = -1;
+
+        bool hasGrown = false;
+        bool sizeChanged = true;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/TextTemplate.h

@@ -0,0 +1,44 @@
+#pragma once
+#include "Game-Lib/UI/Box.h"
+
+#include <Base/Math/Color.h>
+#include <Base/Types.h>
+
+namespace ECS::Components::UI
+{
+    struct TextTemplate
+    {
+    public:
+        struct SetFlags
+        {
+            u8 font : 1 = 0;
+            u8 size : 1 = 0;
+            u8 color : 1 = 0;
+            u8 borderSize : 1 = 0;
+            u8 borderColor : 1 = 0;
+        };
+        SetFlags setFlags;
+
+        std::string font;
+        f32 size;
+        Color color;
+        f32 borderSize;
+        Color borderColor;
+
+        std::string onClickTemplate;
+        std::string onHoverTemplate;
+        std::string onUninteractableTemplate;
+
+        i32 onMouseDownEvent = -1;
+        i32 onMouseUpEvent = -1;
+        i32 onMouseHeldEvent = -1;
+
+        i32 onHoverBeginEvent = -1;
+        i32 onHoverEndEvent = -1;
+        i32 onHoverHeldEvent = -1;
+
+        i32 onFocusBeginEvent = -1;
+        i32 onFocusEndEvent = -1;
+        i32 onFocusHeldEvent = -1;
+    };
+}

Source/Game-Lib/Game-Lib/ECS/Components/UI/Widget.h

@@ -0,0 +1,54 @@
+#pragma once
+#include <Base/Types.h>
+
+namespace Scripting::UI
+{
+    struct Widget;
+}
+
+namespace ECS::Components::UI
+{
+    enum class WidgetType : u8
+    {
+        Canvas,
+        Panel,
+        Text,
+        Widget,
+
+        None
+    };
+
+    enum class WidgetFlags : u8
+    {
+        None = 0,
+
+        Enabled = 1 << 0,
+        Visible = 1 << 1,
+        Interactable = 1 << 2,
+        Focusable = 1 << 3,
+        Resizable = 1 << 4,
+
+        Default = Enabled | Visible | Interactable,
+    };
+    DECLARE_GENERIC_BITWISE_OPERATORS(WidgetFlags);
+
+    struct Widget
+    {
+    public:
+        WidgetType type;
+        WidgetFlags flags = WidgetFlags::Default;
+        Scripting::UI::Widget* scriptWidget = nullptr;
+
+        // Non mutable helper functions
+        inline bool IsEnabled() const { return (flags & WidgetFlags::Enabled) == WidgetFlags::Enabled; }
+        inline bool IsVisible() const { return IsEnabled() && (flags & WidgetFlags::Visible) == WidgetFlags::Visible; }
+        inline bool IsInteractable() const { return IsVisible() && (flags & WidgetFlags::Interactable) == WidgetFlags::Interactable; }
+        inline bool IsFocusable() const { return IsInteractable() && (flags & WidgetFlags::Focusable) == WidgetFlags::Focusable; }
+        inline bool IsResizable() const { return IsInteractable() && (flags & WidgetFlags::Resizable) == WidgetFlags::Resizable; }
+    };
+
+    struct WidgetRoot {};
+    struct DirtyWidgetTransform {};
+    struct DirtyWidgetData {};
+    struct DirtyWidgetFlags {};
+}