Reworked the Engine to allow for better abstraction and more features to be neatly organized.

There are plans to hopefully improve it and make UI Object management much more automatic and robust.

Author: BurntRanch

include/camera.hpp

@@ -52,7 +52,7 @@ class Camera
     Camera(float posX = 0.0f, float posY = 0.0f, float posZ = 0.0f, float upX = 0.0f, float upY = 0.0f, float upZ = 1.0f, float yaw = YAW, float pitch = PITCH);
 
     // returns the view matrix calculated using Euler Angles and the LookAt Matrix
-    glm::mat4 GetViewMatrix();
+    glm::mat4 GetViewMatrix() const;
 
     // processes input received from any keyboard-like input system. Accepts input parameter in the form of camera defined ENUM (to abstract it from windowing systems)
     void ProcessKeyboard(const Camera_Movement& direction, float deltaTime);

include/common.hpp

@@ -13,7 +13,7 @@
 #include <SDL3/SDL_stdinc.h>
 #include <array>
 
-class Engine;
+class Renderer;
 
 struct BufferAndMemory {
     VkBuffer buffer;
@@ -42,7 +42,7 @@ struct TextureImageAndMemory {
 };
 
 struct EngineSharedContext {
-    Engine *engine;
+    Renderer *engine;
 
     VkDevice engineDevice;
     VkPhysicalDevice physicalDevice;
@@ -88,6 +88,8 @@ namespace UI {
 
     class GenericElement {
     public:
+        std::string id;
+
         ElementType genericType;
         ElementType type;
 

include/engine.hpp

@@ -7,6 +7,7 @@
 #include "ui/button.hpp"
 #include <future>
 #include <mutex>
+#include <unordered_map>
 #ifndef VK_EXT_DEBUG_REPORT_EXTENSION_NAME
 #define VK_EXT_DEBUG_REPORT_EXTENSION_NAME "VK_EXT_debug_report"
 #endif
@@ -61,7 +62,7 @@ const std::vector<const char *> requiredInstanceExtensions = {
 
 const std::vector<const char *> requiredLayerExtensions {
 #if DEBUG
-//   "VK_LAYER_KHRONOS_validation",
+//    "VK_LAYER_KHRONOS_validation",
 #endif
 };
 
@@ -90,14 +91,15 @@ struct UIArrowsUBO {
     glm::vec3 Color;
 };
 
+/* Got a weird bug with floats and found out it was because I didn't put alignas(16), I am now extremely paranoid and will put this in every single UBO with a vec2/float. */
 struct UIPanelUBO {
-    glm::vec4 Dimensions;
-    float Depth;
+alignas(16)    glm::vec4 Dimensions;
+alignas(16)    float Depth;
 };
 
 struct UILabelPositionUBO {
-    glm::vec2 PositionOffset;
-    float Depth;
+alignas(16)    glm::vec2 PositionOffset;
+alignas(16)    float Depth;
 };
 
 struct RenderModel {
@@ -172,10 +174,10 @@ struct RenderPass {
     PipelineAndLayout graphicsPipeline;
 };
 
-class Engine {
+class Renderer {
 public:
-    Engine(Settings &settings, Camera *primaryCam) : m_PrimaryCamera(primaryCam), m_Settings(settings) {};
-    ~Engine();
+    Renderer(Settings &settings, const Camera *primaryCam) : m_PrimaryCamera(primaryCam), m_Settings(settings) {};
+    ~Renderer();
 
     void SetMouseCaptureState(bool capturing);
 
@@ -208,6 +210,9 @@ class Engine {
     // Fixed Updates are called 60 times a second.
     void RegisterFixedUpdateFunction(const std::function<void(std::array<bool, 322>)> &func);
 
+    /* DO NOT 'OR' MULTIPLE EVENT TYPES, REGISTER THE SAME FUNCTION WITH A DIFFERENT TYPE IF YOU WANT THAT. */
+    void RegisterSDLEventListener(const std::function<void(SDL_Event *)> &func, SDL_EventType types);
+
     void SetPrimaryCamera(Camera &cam);
 
     Glyph GenerateGlyph(EngineSharedContext &sharedContext, FT_Face ftFace, char c, float &x, float &y, float depth);
@@ -256,9 +261,11 @@ class Engine {
     inline bool HasStencilAttachment(VkFormat format) {return format == VK_FORMAT_D32_SFLOAT_S8_UINT || format == VK_FORMAT_D24_UNORM_S8_UINT;};
 
     /* Cameras, high-level stuff. */
-    Camera *m_PrimaryCamera;
+    const Camera *m_PrimaryCamera;
     Settings &m_Settings;
 
+    std::unordered_map<SDL_EventType, std::vector<std::function<void(SDL_Event *)>>> m_SDLEventListeners;
+
     std::vector<Glyph> m_GlyphCache;
 
     std::vector<RenderUIWaypoint> m_RenderUIWaypoints;
@@ -352,7 +359,36 @@ class Engine {
     std::vector<VkDeviceMemory> m_AllocatedMemory;
     std::vector<VkImageView> m_CreatedImageViews;
     std::vector<VkSampler> m_CreatedSamplers;
+};
+
+class Engine {
+public:
+    Engine() = default;
+
+    void InitRenderer(Settings &settings, const Camera *primaryCamera);
+
+    /* UI::Button listeners will receive events when any button is pressed, along with its ID. */
+    /* Due to how it works, this function can be called before the renderer is initialized. */
+    void RegisterUIButtonListener(const std::function<void(std::string)> listener);
+
+    Renderer *GetRenderer();
+
+    void StartRenderer();
+
+    void LoadUIFile(const std::string &name);
+
+    /* Register a button to the Engine, so that it can forward any clicks inside of it to the UIButton Listeners */
+    void RegisterUIButton(UI::Button *button);
+    void UnregisterUIButton(UI::Button *button);
+private:
+/*  Systems   */
+    Renderer *m_Renderer = nullptr;
+    Settings *m_Settings;
+
+    void CheckButtonClicks(SDL_Event *event);
 
+    std::vector<std::function<void(std::string)>> m_UIButtonListeners;
+    std::vector<UI::Button *> m_UIButtons;
 };
 
 #endif

include/util.hpp

@@ -7,6 +7,9 @@
 #include <array>
 #include <vector>
 #include <string>
+#include <rapidxml.hpp>
+
+
 
 #define UTILASSERT(expr)        (static_cast<bool>(expr)    \
                                     ? void(0)   \
@@ -16,5 +19,11 @@ bool                     intersects(const glm::vec3 &origin, const glm::vec3 &fr
 std::vector<std::string> split(const std::string_view text, const char delim);
 bool                     endsWith(const std::string_view fullString, const std::string_view ending);
 glm::vec2                adjustScaleToFitType(UI::Scalable *self, glm::vec2 scale, UI::FitType fitType = UI::UNSET);
+rapidxml::xml_node<char>*getPropertiesNode(rapidxml::xml_node<char> *uiObjectNode);
+std::string              getID(rapidxml::xml_node<char> *propertiesNode);
+glm::vec3                getColor(rapidxml::xml_node<char> *propertiesNode);
+glm::vec2                getPosition(rapidxml::xml_node<char> *propertiesNode);
+glm::vec2                getScale(rapidxml::xml_node<char> *propertiesNode);
+float                    getZDepth(rapidxml::xml_node<char> *propertiesNode, float depthDefault = 1.0f);
 
 #endif

src/camera.cpp

@@ -20,7 +20,7 @@ Camera::Camera(float posX, float posY, float posZ, float upX, float upY, float u
 }
 
 // returns the view matrix calculated using Euler Angles and the LookAt Matrix
-glm::mat4 Camera::GetViewMatrix()
+glm::mat4 Camera::GetViewMatrix() const
 {
     return glm::lookAt(Position, Position + Front, Up);
 }