brenta: general polishing and documentation improvement

Author: San7o

README.md

@@ -1,7 +1,7 @@
 ![Brenta-Engine-Banner](./utils/docs-images/brenta-engine-banner.png)
 
 **Brenta Engine** is a simple 3D graphics engine written in modern
-C++/OpenGL using a hybrid scene-graph and Entity Component System
+C++/OpenGL using a hybrid node-graph and Entity Component System
 architecture.
 
 Check out [DESIGN.md](./docs/DESIGN.md) for an overview of
@@ -14,7 +14,7 @@ introduction to its API.
 - GPU particles
 - loading TrueType fonts, textures, audio and .obj meshes
 - central asset management
-- scene graph
+- node graph
 - ECS
 - lua node scripting
 - GUI using ImGui

TODO

@@ -1,3 +0,0 @@
-- remove unnecessary setters and getters
-- add drawable abstraction for the renderer
-- rework website

docs/DESIGN.md

@@ -1,18 +1,5 @@
 # Design
 
-I could tell you that the Brenta engine was perfectly designed, with a
-clear vision from its inception, with a beautiful and powerful API
-that makes programming truly enjoyable. Except the fact that it would
-be a lie. I do not mean that I don't find the current design and API
-beautiful and fun - I think Brenta is a powerful engine - but its
-development has been more iterative than meticulously designed. I
-rewrote huge parts of the engine many many times, to the point where I
-am not scared to do big refactoring anymore - that is just routine -
-and I know I am deemed to repeat this process again. But through these
-many refactoring, the API reached a point where all objects work well
-together and you can reason about them through what I call the
-"architecture" or "design" of the engine. This is what I aim to
-describe in this documents.
 
 Game engines are complex pieces of software. They provide an interface
 to define logic, render graphics, and access system resources like
@@ -21,6 +8,15 @@ the developer.
 
 ![high-level-overview](./brenta-picture.png)
 
+Brenta's its development has been more iterative than meticulously
+designed. I rewrote huge parts of the engine many many times, to the
+point where I am not scared to do big refactoring anymore - that is
+just routine - and I know I am deemed to repeat this process
+again. But through these many refactoring, the API reached a point
+where all objects work well together and you can reason about them
+through what I call the "architecture" or "design" of the engine. This
+is what I aim to describe in this documents.
+
 I wanted to write my own graphics engine primarily because I was
 curious to understand how these big systems are designed and
 implemented, and as a programming exercise / learning experience. The
@@ -94,7 +90,7 @@ provides the abstractions necessary to integrate other methods.
 ## Scene
 
 There are many ways to define a scene. Brenta supports both the
-scene-graph architecture, commonly used in Godot, Unity and Unreal,
+node-graph architecture, commonly used in Godot, Unity and Unreal,
 and the ECS (Entity Component System) architecture like in
 [Bevy](https://github.com/bevyengine/bevy/).
 

docs/GUIDE.md

@@ -120,7 +120,7 @@ ModelNodeComponent(Model&& m, bool transparent = false);
 ModelNodeComponent(tenno::shared_ptr<Model> m, bool transparent = false);
 ```
 
-In general, more "high-level" objects (such as the scene-graph) work
+In general, more "high-level" objects (such as the node-graph) work
 with shared pointers, while "low-level" objects such as textures and
 meshes store their data directly without pointers. If you only work
 with these objects you are not required to create shared pointers for

examples/aircraft.cpp

@@ -115,11 +115,11 @@ int main()
 
   // Camera movement
 
-  auto camera        = scene.get_camera();  
+  auto camera            = scene.get_camera();  
   glm::vec3 acceleration = glm::vec3(0.0);
   glm::vec3 speed        = glm::vec3(0.0);
 
-  Mouse mouse = {};
+  Mouse mouse        = {};
   mouse.set_sensitivity(0.05f);
   bool capture_mouse = true;
 
@@ -145,10 +145,10 @@ int main()
     delta_x *= sensitivity;
     delta_y *= sensitivity;
 
-    auto pos = camera->get_pos();
+    auto pos  = camera->get_pos();
     auto acam = std::get<Camera::Aircraft>(pos);
 
-    acam.yaw += delta_x;
+    acam.yaw   += delta_x;
     acam.pitch -= delta_y;
     camera->set_pos(acam);
     return;
@@ -167,7 +167,7 @@ int main()
 
   while (!Window::should_close())
   {
-    float delta_time = Window::get_time().get_delta();
+    float delta_time = Window::get_time().delta;
     if (Window::is_key_pressed(Key::Escape))
       Window::close();
     if (Window::is_key_pressed(Key::W))

examples/app.cpp

@@ -99,7 +99,7 @@ bool App::setup()
                                    scene_builder);
   auto root_node  = scene->get_root();
   auto model_node = Scene::create_child(root_node);
-  model_node->set_local(glm::vec3(10.0f, 0.0f, 0.0f));
+  model_node->transform = glm::vec3(10.0f, 0.0f, 0.0f);
   Scene::add_component(model_node, model_component);
 
   return true;
@@ -114,9 +114,18 @@ bool App::update(float delta_time)
   Gl::clear();
 
   auto scene = AssetManager::get<Scene>("main_scene");
-  if (!scene) return true;
+  if (!scene) return false;
 
   scene->update(delta_time);
+
+  return true;
+}
+
+bool App::draw()
+{
+  auto scene = AssetManager::get<Scene>("main_scene");
+  if (!scene) return false;
+
   scene->draw();
 
   return true;

examples/asset_manager.cpp

@@ -96,13 +96,13 @@ int main()
 
   auto root_node  = scene->get_root();
   auto model_node = Scene::create_child(root_node);
-  model_node->set_local(glm::vec3(10.0f, 0.0f, 0.0f));
+  model_node->transform = glm::vec3(10.0f, 0.0f, 0.0f);
 
   Scene::add_component(model_node, model_component);
 
   while (!Window::should_close())
   {
-    auto delta_time = Window::get_time().get_delta();
+    auto delta_time = Window::get_time().delta;
     if (Window::is_key_pressed(Key::Escape))
       Window::close();
 

examples/demo/include/demo/systems/physics.hpp

@@ -33,7 +33,7 @@ struct PhysicsSystem : System<PhysicsEcsComponent,
       auto transform_component =
         World::entity_to_component<TransformEcsComponent>(match);
 
-      auto dt = Window::get_time().get_delta();
+      auto dt = Window::get_time().delta;
       if (physics_component->acceleration != glm::vec3(0.0f))
       {
         physics_component->velocity += physics_component->acceleration * dt;

examples/demo/include/demo/systems/sprite_animation.hpp

@@ -27,8 +27,7 @@ struct SpriteAnimationSystem : System<SpriteAnimationEcsComponent,
   {
     for (auto& entity : matches)
     {
-      // TODO: update the sprite index after some time
-      auto dt = Window::get_time().get_delta();
+      auto dt = Window::get_time().delta;
 
       auto e = Entity(entity);
       auto sprite_animation =

examples/hot_reloading.cpp

@@ -139,7 +139,7 @@ int main()
 
   // Point light
   auto point_node = Scene::create_child(root_node);
-  point_node->get_local().translate({-2.0, 2.0, 0.0});
+  point_node->transform.translate({-2.0, 2.0, 0.0});
   auto point_light_component =
     tenno::make_shared<PointLightNodeComponent>(phong_point_ptr);
   Scene::add_component(point_node, point_light_component);
@@ -314,7 +314,7 @@ int main()
 
   while (!Window::should_close())
   {
-    float delta_time = Window::get_time().get_delta();
+    float delta_time = Window::get_time().delta;
     if (Window::is_key_pressed(Key::Escape))
       Window::close();