refactor: move Cubos to core

GameDevTecnico · Jan 29, 2024 · 96bc851 · 96bc851
1 parent c7d9aeb
commit 96bc851
Show file tree

Hide file tree

Showing 40 changed files with 67 additions and 52 deletions.
diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
@@ -113,6 +113,7 @@ set(CUBOS_CORE_SOURCE
     "src/cubos/core/ecs/world.cpp"
     "src/cubos/core/ecs/command_buffer.cpp"
     "src/cubos/core/ecs/types.cpp"
+    "src/cubos/core/ecs/cubos.cpp"
 
     "src/cubos/core/geom/box.cpp"
     "src/cubos/core/geom/capsule.cpp"

diff --git a/engine/include/cubos/engine/cubos.hpp → core/include/cubos/core/ecs/cubos.hpp b/engine/include/cubos/engine/cubos.hpp → core/include/cubos/core/ecs/cubos.hpp
@@ -12,15 +12,13 @@
 #include <cubos/core/ecs/system/system.hpp>
 #include <cubos/core/ecs/world.hpp>
 
-#include <cubos/engine/prelude.hpp>
-
-namespace cubos::engine
+namespace cubos::core::ecs
 {
     /// @brief Resource which stores the time since the last iteration of the main loop started.
     ///
     /// This resource is added and updated by the @ref Cubos class.
     ///
-    /// @ingroup engine
+    /// @ingroup core-ecs
     struct DeltaTime
     {
         DeltaTime(float value);
@@ -32,7 +30,7 @@ namespace cubos::engine
     ///
     /// This resource is added by the @ref Cubos class, initially set to true.
     ///
-    /// @ingroup engine
+    /// @ingroup core-ecs
     struct ShouldQuit
     {
         ShouldQuit(bool value);
@@ -44,7 +42,7 @@ namespace cubos::engine
     ///
     /// This resource is added by the @ref Cubos class.
     ///
-    /// @ingroup engine
+    /// @ingroup core-ecs
     struct Arguments
     {
         Arguments(std::vector<std::string> value);
@@ -53,7 +51,7 @@ namespace cubos::engine
     };
 
     /// @brief Used to chain configurations related to tags.
-    /// @ingroup engine
+    /// @ingroup core-ecs
     class TagBuilder
     {
     public:
@@ -87,7 +85,7 @@ namespace cubos::engine
     };
 
     /// @brief Used to chain configurations related to systems
-    /// @ingroup engine
+    /// @ingroup core-ecs
     class SystemBuilder
     {
     public:
@@ -126,7 +124,7 @@ namespace cubos::engine
 
     /// @brief Represents the engine itself, and exposes the interface with which the game
     /// developer interacts with. Ties up all the different parts of the engine together.
-    /// @ingroup engine
+    /// @ingroup core-ecs
     class Cubos final
     {
     public:
@@ -269,4 +267,4 @@ namespace cubos::engine
         mStartupDispatcher.addSystem(func);
         return {mStartupDispatcher, mMainTags};
     }
-} // namespace cubos::engine
+} // namespace cubos::core::ecs
diff --git a/engine/src/cubos/engine/cubos.cpp → core/src/cubos/core/ecs/cubos.cpp b/engine/src/cubos/engine/cubos.cpp → core/src/cubos/core/ecs/cubos.cpp
@@ -1,12 +1,16 @@
 #include <utility>
 
 #include <cubos/core/ecs/command_buffer.hpp>
+#include <cubos/core/ecs/cubos.hpp>
 #include <cubos/core/log.hpp>
 #include <cubos/core/reflection/external/string.hpp>
 
-#include <cubos/engine/cubos.hpp>
-
-using namespace cubos::engine;
+using cubos::core::ecs::Arguments;
+using cubos::core::ecs::Cubos;
+using cubos::core::ecs::DeltaTime;
+using cubos::core::ecs::ShouldQuit;
+using cubos::core::ecs::SystemBuilder;
+using cubos::core::ecs::TagBuilder;
 
 DeltaTime::DeltaTime(float value)
     : value(value)

diff --git a/docs/pages/2_features/plugins.md b/docs/pages/2_features/plugins.md
@@ -19,11 +19,11 @@ An application which just prints `"Hello World!"` and which does absolutely
 nothing else - not even open a window - would look like this:
 
 ```cpp
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 #include <iostream>
 
-using Cubos = cubos::engine::Cubos;
+using cubos::engine::Cubos;
 
 void helloWorld()
 {
@@ -56,11 +56,11 @@ If we were to put the hello world functionality on a plugin, the previous
 example would look like this:
 
 ```cpp
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 #include <iostream>
 
-using Cubos = cubos::engine::Cubos;
+using cubos::engine::Cubos;
 
 void helloWorld()
 {

diff --git a/engine/CMakeLists.txt b/engine/CMakeLists.txt
@@ -9,7 +9,6 @@ message("# Building engine tests: " ${BUILD_ENGINE_TESTS})
 
 # Set engine source files
 set(CUBOS_ENGINE_SOURCE
-	"src/cubos/engine/cubos.cpp"
 	"src/cubos/engine/prelude.cpp"
 
 	"src/cubos/engine/settings/plugin.cpp"

diff --git a/engine/include/cubos/engine/assets/plugin.hpp b/engine/include/cubos/engine/assets/plugin.hpp
@@ -8,7 +8,7 @@
 #pragma once
 
 #include <cubos/engine/assets/assets.hpp>
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/collisions/plugin.hpp b/engine/include/cubos/engine/collisions/plugin.hpp
@@ -13,7 +13,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/gizmos/gizmos.hpp b/engine/include/cubos/engine/gizmos/gizmos.hpp
@@ -11,7 +11,7 @@
 
 #include <cubos/core/gl/render_device.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/gizmos/plugin.hpp b/engine/include/cubos/engine/gizmos/plugin.hpp
@@ -7,8 +7,8 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
 #include <cubos/engine/gizmos/gizmos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/imgui/plugin.hpp b/engine/include/cubos/engine/imgui/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/input/plugin.hpp b/engine/include/cubos/engine/input/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/input/input.hpp>
 
 namespace cubos::engine

diff --git a/engine/include/cubos/engine/physics/plugin.hpp b/engine/include/cubos/engine/physics/plugin.hpp
@@ -12,7 +12,7 @@
 #include <cubos/core/reflection/external/glm.hpp>
 #include <cubos/core/reflection/external/primitives.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/physics/components/accumulated_correction.hpp>
 #include <cubos/engine/physics/components/physics_mass.hpp>
 #include <cubos/engine/physics/components/physics_velocity.hpp>

diff --git a/engine/include/cubos/engine/physics/plugins/gravity.hpp b/engine/include/cubos/engine/physics/plugins/gravity.hpp
@@ -4,7 +4,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/physics/components/physics_mass.hpp>
 #include <cubos/engine/physics/components/physics_velocity.hpp>
 #include <cubos/engine/physics/resources/gravity.hpp>

diff --git a/engine/include/cubos/engine/prelude.hpp b/engine/include/cubos/engine/prelude.hpp
@@ -1,5 +1,6 @@
 #pragma once
 
+#include <cubos/core/ecs/cubos.hpp>
 #include <cubos/core/ecs/entity/entity.hpp>
 #include <cubos/core/ecs/system/event/reader.hpp>
 #include <cubos/core/ecs/system/event/writer.hpp>
@@ -8,6 +9,18 @@
 
 namespace cubos::engine
 {
+    /// @copydoc cubos::core::ecs::Cubos
+    using Cubos = core::ecs::Cubos;
+
+    /// @copydoc cubos::core::ecs::DeltaTime
+    using DeltaTime = core::ecs::DeltaTime;
+
+    /// @copydoc cubos::core::ecs::ShouldQuit
+    using ShouldQuit = core::ecs::ShouldQuit;
+
+    /// @copydoc cubos::core::ecs::Arguments
+    using Arguments = core::ecs::Arguments;
+
     /// @copydoc cubos::core::ecs::Query
     template <typename... ComponentTypes>
     using Query = core::ecs::Query<ComponentTypes...>;

diff --git a/engine/include/cubos/engine/scene/plugin.hpp b/engine/include/cubos/engine/scene/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/scene/scene.hpp>
 
 namespace cubos::engine

diff --git a/engine/include/cubos/engine/screen_picker/plugin.hpp b/engine/include/cubos/engine/screen_picker/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/screen_picker/screen_picker.hpp>
 
 namespace cubos::engine

diff --git a/engine/include/cubos/engine/screen_picker/screen_picker.hpp b/engine/include/cubos/engine/screen_picker/screen_picker.hpp
@@ -6,7 +6,7 @@
 
 #include <cubos/core/gl/render_device.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/settings/plugin.hpp b/engine/include/cubos/engine/settings/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/settings/settings.hpp>
 
 namespace cubos::engine

diff --git a/engine/include/cubos/engine/splitscreen/plugin.hpp b/engine/include/cubos/engine/splitscreen/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/transform/plugin.hpp b/engine/include/cubos/engine/transform/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/transform/local_to_world.hpp>
 #include <cubos/engine/transform/position.hpp>
 #include <cubos/engine/transform/rotation.hpp>

diff --git a/engine/include/cubos/engine/utils/free_camera_controller/plugin.hpp b/engine/include/cubos/engine/utils/free_camera_controller/plugin.hpp
@@ -9,7 +9,7 @@
 
 #include <cubos/core/ecs/system/event/reader.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/input/input.hpp>
 #include <cubos/engine/input/plugin.hpp>
 #include <cubos/engine/transform/position.hpp>

diff --git a/engine/include/cubos/engine/voxels/plugin.hpp b/engine/include/cubos/engine/voxels/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/include/cubos/engine/window/plugin.hpp b/engine/include/cubos/engine/window/plugin.hpp
@@ -9,7 +9,7 @@
 
 #include <cubos/core/io/window.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/samples/events/main.cpp b/engine/samples/events/main.cpp
@@ -2,7 +2,7 @@
 #include <cubos/core/ecs/system/event/writer.hpp>
 #include <cubos/core/reflection/external/primitives.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 using namespace cubos::engine;
 

diff --git a/engine/samples/gizmos/main.cpp b/engine/samples/gizmos/main.cpp
@@ -1,4 +1,4 @@
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/gizmos/plugin.hpp>
 #include <cubos/engine/renderer/plugin.hpp>
 #include <cubos/engine/settings/settings.hpp>

diff --git a/engine/samples/hello-cubos/main.cpp b/engine/samples/hello-cubos/main.cpp
@@ -3,7 +3,7 @@
 /// [Include Components]
 
 /// [Include]
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 using cubos::engine::Cubos;
 /// [Include]

diff --git a/engine/samples/settings/main.cpp b/engine/samples/settings/main.cpp
@@ -1,6 +1,6 @@
 #include <cubos/core/reflection/external/string.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/settings/plugin.hpp>
 
 using namespace cubos::engine;

diff --git a/engine/src/cubos/engine/collisions/broad_phase/plugin.hpp b/engine/src/cubos/engine/collisions/broad_phase/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace cubos::engine
 {

diff --git a/engine/src/cubos/engine/screen_picker/plugin.cpp b/engine/src/cubos/engine/screen_picker/plugin.cpp
@@ -1,6 +1,6 @@
 #include <cubos/core/io/window.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 #include <cubos/engine/screen_picker/plugin.hpp>
 #include <cubos/engine/screen_picker/screen_picker.hpp>
 #include <cubos/engine/window/plugin.hpp>

diff --git a/tools/tesseratos/include/tesseratos/debug_camera/plugin.hpp b/tools/tesseratos/include/tesseratos/debug_camera/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace tesseratos
 {

diff --git a/tools/tesseratos/include/tesseratos/entity_inspector/plugin.hpp b/tools/tesseratos/include/tesseratos/entity_inspector/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace tesseratos
 {

diff --git a/tools/tesseratos/include/tesseratos/entity_selector/plugin.hpp b/tools/tesseratos/include/tesseratos/entity_selector/plugin.hpp
@@ -9,7 +9,7 @@
 
 #include <cubos/core/ecs/entity/entity.hpp>
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace tesseratos
 {

diff --git a/tools/tesseratos/include/tesseratos/metrics_panel/plugin.hpp b/tools/tesseratos/include/tesseratos/metrics_panel/plugin.hpp
@@ -7,7 +7,7 @@
 
 #pragma once
 
-#include <cubos/engine/cubos.hpp>
+#include <cubos/engine/prelude.hpp>
 
 namespace tesseratos
 {