Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

refactor(engine): the UI subsystem stops living in the ecs's spare room

esengine5934ba85df7a
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 50eb93d95..0a7918f7a 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -155,7 +155,7 @@ list(APPEND ESENGINE_HEADERS
set(GENERATED_WEB_BINDINGS "${CMAKE_CURRENT_SOURCE_DIR}/src/esengine/bindings/WebBindings.generated.cpp")
set(GENERATED_EDITOR_API "${CMAKE_CURRENT_SOURCE_DIR}/src/esengine/bindings/EditorAPI.generated.cpp")
-set(GENERATED_TS_DEFINITIONS "${CMAKE_CURRENT_SOURCE_DIR}/sdk/src/wasm.generated.ts")
+set(GENERATED_TS_DEFINITIONS "${CMAKE_CURRENT_SOURCE_DIR}/sdk/src/wasm/wasm.generated.ts")
list(APPEND ESENGINE_SOURCES
src/esengine/platform/web/WebFileSystem.cpp
diff --git a/cmake/ESEngineSources.cmake b/cmake/ESEngineSources.cmake
index 1be810e92..a2df3f686 100644
--- a/cmake/ESEngineSources.cmake
+++ b/cmake/ESEngineSources.cmake
@@ -38,8 +38,8 @@ set(ESENGINE_SOURCES
${ESENGINE_ROOT}/src/esengine/trail/TrailSystem.cpp
${ESENGINE_ROOT}/src/esengine/platform/PathResolver.cpp
${ESENGINE_ROOT}/src/esengine/animation/TweenSystem.cpp
- ${ESENGINE_ROOT}/src/esengine/ecs/UILayoutSystem.cpp
- ${ESENGINE_ROOT}/src/esengine/ecs/UISystem.cpp
+ ${ESENGINE_ROOT}/src/esengine/ui/UILayoutSystem.cpp
+ ${ESENGINE_ROOT}/src/esengine/ui/UISystem.cpp
)
# WebGL2 (GLES3) backend — the web/WeChat platform only. A native build renders
diff --git a/src/esengine/bindings/UIBindings.cpp b/src/esengine/bindings/UIBindings.cpp
index 0029b3c69..44a362964 100644
--- a/src/esengine/bindings/UIBindings.cpp
+++ b/src/esengine/bindings/UIBindings.cpp
@@ -15,8 +15,8 @@
#include "../core/EstellaContext.hpp"
#include "../core/World.hpp"
#include "../ecs/Registry.hpp"
-#include "../ecs/UISystem.hpp"
-#include "../ecs/UIRenderOrderSystem.hpp"
+#include "../ui/UISystem.hpp"
+#include "../ui/UIRenderOrderSystem.hpp"
#include "../ecs/TransformSystem.hpp"
#include "../ecs/components/Transform.hpp"
#include "../ecs/components/UINode.hpp"
diff --git a/src/esengine/bindings/WebBindings.generated.cpp b/src/esengine/bindings/WebBindings.generated.cpp
index e2a7321bd..d9915d12c 100644
--- a/src/esengine/bindings/WebBindings.generated.cpp
+++ b/src/esengine/bindings/WebBindings.generated.cpp
@@ -9,7 +9,7 @@
#include <string>
#include "../ecs/Registry.hpp"
#include "../math/Math.hpp"
-#include "../core/UITypes.hpp"
+#include "../ui/UITypes.hpp"
#include "../ecs/TransformSystem.hpp"
#include "../ecs/components/BitmapText.hpp"
#include "../ecs/components/Camera.hpp"
diff --git a/src/esengine/bindings/WebSDKEntry.cpp b/src/esengine/bindings/WebSDKEntry.cpp
index 4155323b9..658c408e1 100644
--- a/src/esengine/bindings/WebSDKEntry.cpp
+++ b/src/esengine/bindings/WebSDKEntry.cpp
@@ -33,10 +33,10 @@
#include "TilemapBindings.hpp"
#endif
-#include "../ecs/UILayoutSystem.hpp"
-#include "../ecs/UIHitTestSystem.hpp"
-#include "../ecs/UIRenderOrderSystem.hpp"
-#include "../ecs/UISystem.hpp"
+#include "../ui/UILayoutSystem.hpp"
+#include "../ui/UIHitTestSystem.hpp"
+#include "../ui/UIRenderOrderSystem.hpp"
+#include "../ui/UISystem.hpp"
#include "../renderer/OpenGLHeaders.hpp"
#include "../renderer/GfxDevice.hpp"
diff --git a/src/esengine/core/EstellaContext.cpp b/src/esengine/core/EstellaContext.cpp
index b89e4600a..946db160e 100644
--- a/src/esengine/core/EstellaContext.cpp
+++ b/src/esengine/core/EstellaContext.cpp
@@ -37,7 +37,7 @@
#endif
#include "../resource/ResourceManager.hpp"
#include "../ecs/TransformSystem.hpp"
-#include "../ecs/UISystem.hpp"
+#include "../ui/UISystem.hpp"
#include "../animation/TweenSystem.hpp"
#ifdef ES_PLATFORM_WEB
diff --git a/src/esengine/ecs/components/FlexContainer.hpp b/src/esengine/ecs/components/FlexContainer.hpp
index cdb01bc65..6443fc917 100644
--- a/src/esengine/ecs/components/FlexContainer.hpp
+++ b/src/esengine/ecs/components/FlexContainer.hpp
@@ -3,7 +3,7 @@
#pragma once
#include "../../core/Types.hpp"
-#include "../../core/UITypes.hpp"
+#include "../../ui/UITypes.hpp"
#include "../../core/Reflection.hpp"
#include "../../math/Math.hpp"
diff --git a/src/esengine/ecs/components/UINode.hpp b/src/esengine/ecs/components/UINode.hpp
index 24bd90a25..daa041568 100644
--- a/src/esengine/ecs/components/UINode.hpp
+++ b/src/esengine/ecs/components/UINode.hpp
@@ -3,7 +3,7 @@
#pragma once
#include "../../core/Types.hpp"
-#include "../../core/UITypes.hpp" // Dimension
+#include "../../ui/UITypes.hpp" // Dimension
#include "../../core/Reflection.hpp"
#include "../../math/Math.hpp" // glm::vec2 (computed output)
diff --git a/src/esengine/ecs/UIHitTestSystem.hpp b/src/esengine/ui/UIHitTestSystem.hpp
similarity index 92%
rename from src/esengine/ecs/UIHitTestSystem.hpp
rename to src/esengine/ui/UIHitTestSystem.hpp
index a100fe096..d8f1a1837 100644
--- a/src/esengine/ecs/UIHitTestSystem.hpp
+++ b/src/esengine/ui/UIHitTestSystem.hpp
@@ -8,11 +8,11 @@
*/
#pragma once
-#include "Registry.hpp"
-#include "components/Transform.hpp"
-#include "components/Hierarchy.hpp"
-#include "components/UINode.hpp"
-#include "components/UIMask.hpp"
+#include "../ecs/Registry.hpp"
+#include "../ecs/components/Transform.hpp"
+#include "../ecs/components/Hierarchy.hpp"
+#include "../ecs/components/UINode.hpp"
+#include "../ecs/components/UIMask.hpp"
#include <cmath>
diff --git a/src/esengine/ecs/UILayoutSystem.cpp b/src/esengine/ui/UILayoutSystem.cpp
similarity index 98%
rename from src/esengine/ecs/UILayoutSystem.cpp
rename to src/esengine/ui/UILayoutSystem.cpp
index 58f2e03c7..fe525a51a 100644
--- a/src/esengine/ecs/UILayoutSystem.cpp
+++ b/src/esengine/ui/UILayoutSystem.cpp
@@ -1,12 +1,12 @@
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
-#include "UILayoutSystem.hpp"
-#include "UISystem.hpp"
+#include "./UILayoutSystem.hpp"
+#include "./UISystem.hpp"
-#include "components/Transform.hpp"
-#include "components/Canvas.hpp"
-#include "components/FlexContainer.hpp"
-#include "components/UINode.hpp" // UINode + AlignSelf
+#include "../ecs/components/Transform.hpp"
+#include "../ecs/components/Canvas.hpp"
+#include "../ecs/components/FlexContainer.hpp"
+#include "../ecs/components/UINode.hpp" // UINode + AlignSelf
#include <yoga/Yoga.h>
#include <unordered_map>
diff --git a/src/esengine/ecs/UILayoutSystem.hpp b/src/esengine/ui/UILayoutSystem.hpp
similarity index 92%
rename from src/esengine/ecs/UILayoutSystem.hpp
rename to src/esengine/ui/UILayoutSystem.hpp
index 2532d06f5..6c29df3a2 100644
--- a/src/esengine/ecs/UILayoutSystem.hpp
+++ b/src/esengine/ui/UILayoutSystem.hpp
@@ -2,8 +2,8 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
#pragma once
-#include "Registry.hpp"
-#include "UITree.hpp"
+#include "../ecs/Registry.hpp"
+#include "./UITree.hpp"
#include <glm/glm.hpp>
diff --git a/src/esengine/ecs/UIRenderOrderSystem.hpp b/src/esengine/ui/UIRenderOrderSystem.hpp
similarity index 83%
rename from src/esengine/ecs/UIRenderOrderSystem.hpp
rename to src/esengine/ui/UIRenderOrderSystem.hpp
index 4aa5fb483..b2f807f55 100644
--- a/src/esengine/ecs/UIRenderOrderSystem.hpp
+++ b/src/esengine/ui/UIRenderOrderSystem.hpp
@@ -2,12 +2,12 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
#pragma once
-#include "Registry.hpp"
-#include "components/Hierarchy.hpp"
-#include "components/UINode.hpp"
-#include "components/Sprite.hpp"
-#include "components/UIVisual.hpp"
-#include "components/Canvas.hpp"
+#include "../ecs/Registry.hpp"
+#include "../ecs/components/Hierarchy.hpp"
+#include "../ecs/components/UINode.hpp"
+#include "../ecs/components/Sprite.hpp"
+#include "../ecs/components/UIVisual.hpp"
+#include "../ecs/components/Canvas.hpp"
namespace esengine::ecs {
diff --git a/src/esengine/ecs/UISystem.cpp b/src/esengine/ui/UISystem.cpp
similarity index 93%
rename from src/esengine/ecs/UISystem.cpp
rename to src/esengine/ui/UISystem.cpp
index 18063bed1..f13c8cd2e 100644
--- a/src/esengine/ecs/UISystem.cpp
+++ b/src/esengine/ui/UISystem.cpp
@@ -7,14 +7,14 @@
* anonymous-namespace helpers (resolveFlexChildren, etc.).
*/
-#include "UISystem.hpp"
-#include "UIHitTestSystem.hpp"
-
-#include "components/Interactable.hpp"
-#include "components/Transform.hpp"
-#include "components/UIInteraction.hpp"
-#include "components/UINode.hpp"
-#include "components/UIVisual.hpp"
+#include "./UISystem.hpp"
+#include "./UIHitTestSystem.hpp"
+
+#include "../ecs/components/Interactable.hpp"
+#include "../ecs/components/Transform.hpp"
+#include "../ecs/components/UIInteraction.hpp"
+#include "../ecs/components/UINode.hpp"
+#include "../ecs/components/UIVisual.hpp"
#include <algorithm>
#include <cstdint>
diff --git a/src/esengine/ecs/UISystem.hpp b/src/esengine/ui/UISystem.hpp
similarity index 98%
rename from src/esengine/ecs/UISystem.hpp
rename to src/esengine/ui/UISystem.hpp
index 3088a374c..498a4c0ba 100644
--- a/src/esengine/ecs/UISystem.hpp
+++ b/src/esengine/ui/UISystem.hpp
@@ -13,9 +13,9 @@
#pragma once
#include "../core/Types.hpp"
-#include "Entity.hpp"
-#include "Registry.hpp"
-#include "UITree.hpp"
+#include "../ecs/Entity.hpp"
+#include "../ecs/Registry.hpp"
+#include "./UITree.hpp"
#include <memory>
#include <vector>
diff --git a/src/esengine/ecs/UITree.hpp b/src/esengine/ui/UITree.hpp
similarity index 94%
rename from src/esengine/ecs/UITree.hpp
rename to src/esengine/ui/UITree.hpp
index 7bf9a5888..6cbf98aaf 100644
--- a/src/esengine/ecs/UITree.hpp
+++ b/src/esengine/ui/UITree.hpp
@@ -2,11 +2,11 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
#pragma once
-#include "Registry.hpp"
-#include "components/Hierarchy.hpp"
-#include "components/UINode.hpp"
-#include "components/Canvas.hpp"
-#include "components/Transform.hpp"
+#include "../ecs/Registry.hpp"
+#include "../ecs/components/Hierarchy.hpp"
+#include "../ecs/components/UINode.hpp"
+#include "../ecs/components/Canvas.hpp"
+#include "../ecs/components/Transform.hpp"
#include <vector>
diff --git a/src/esengine/core/UITypes.hpp b/src/esengine/ui/UITypes.hpp
similarity index 96%
rename from src/esengine/core/UITypes.hpp
rename to src/esengine/ui/UITypes.hpp
index 3b15d40b7..00e65d2e8 100644
--- a/src/esengine/core/UITypes.hpp
+++ b/src/esengine/ui/UITypes.hpp
@@ -2,7 +2,7 @@
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
#pragma once
-#include "Types.hpp"
+#include "../core/Types.hpp"
namespace esengine {
diff --git a/tools/eht/generators/embind.py b/tools/eht/generators/embind.py
index 9e2bd5128..4cf142834 100644
--- a/tools/eht/generators/embind.py
+++ b/tools/eht/generators/embind.py
@@ -70,7 +70,7 @@ class EmbindGenerator:
'#include <string>',
'#include "../ecs/Registry.hpp"',
'#include "../math/Math.hpp"',
- '#include "../core/UITypes.hpp"',
+ '#include "../ui/UITypes.hpp"',
]
def _gen_includes(self) -> List[str]:
diff --git a/tools/eht/generators/metadata.py b/tools/eht/generators/metadata.py
index 48ebb76fc..15653fdca 100644
--- a/tools/eht/generators/metadata.py
+++ b/tools/eht/generators/metadata.py
@@ -278,7 +278,7 @@ class MetadataGenerator:
' * @details Generated by EHT - DO NOT EDIT',
' */',
'',
- "import type { AssetFieldType } from '../scene';",
+ "import type { AssetFieldType } from '../scene/scene';",
"import type { FieldMeta } from './component';",
]
if used_base:
diff --git a/tools/eht/type_system.py b/tools/eht/type_system.py
index 94793f9ee..3e4f2fc89 100644
--- a/tools/eht/type_system.py
+++ b/tools/eht/type_system.py
@@ -20,7 +20,7 @@ class TypeSystem:
# Generalizes the former single Padding special case. Each entry maps a struct
# name to its ordered (member_name, member_cpp_type) list; the struct must be
# defined in the esengine:: namespace and included by WebBindings
- # (core/UITypes.hpp) and be a standard C++ POD.
+ # (ui/UITypes.hpp) and be a standard C++ POD.
#
# Structs used as a DIRECT component field (Padding/Dimension) must have only
# primitive members in PtrLayoutGenerator.TYPE_SIZES (they go through the