feat(tesseratos): add metrics plugin

tools/tesseratos/CMakeLists.txt

@@ -14,6 +14,7 @@ set(TESSERATOS_SOURCE
     "src/tesseratos/scene_editor/plugin.cpp"
     "src/tesseratos/debug_camera/plugin.cpp"
     "src/tesseratos/voxel_palette_editor/plugin.cpp"
+    "src/tesseratos/metrics_panel/plugin.cpp"
 )
 
 add_library(tesseratos ${TESSERATOS_SOURCE})

tools/tesseratos/include/tesseratos/metrics_panel/plugin.hpp

@@ -0,0 +1,25 @@
+/// @dir
+/// @brief @ref tesseratos-metrics-panel-plugin plugin directory.
+
+/// @file
+/// @brief Plugin entry point.
+/// @ingroup tesseratos-metrics-panel-plugin
+
+#pragma once
+
+#include <cubos/engine/cubos.hpp>
+
+namespace tesseratos
+{
+    /// @defgroup tesseratos-metrics-panel-plugin Metrics
+    /// @ingroup tesseratos
+    /// @brief Shows some useful performance metrics through a ImGui window.
+    ///
+    /// ## Dependencies
+    /// - @ref imgui-plugin
+
+    /// @brief Plugin entry function.
+    /// @param cubos @b CUBOS. main class
+    /// @ingroup tesseratos-metrics-panel-plugin
+    void metricsPanelPlugin(cubos::engine::Cubos& cubos);
+} // namespace tesseratos

tools/tesseratos/src/tesseratos/metrics_panel/plugin.cpp

@@ -0,0 +1,82 @@
+#include <numeric> //Included for the accumulated/max_element funcs
+
+#include <imgui.h>
+#include <implot.h>
+
+#include <cubos/engine/imgui/plugin.hpp>
+
+#include <tesseratos/metrics_panel/plugin.hpp>
+
+using cubos::core::ecs::Read;
+using cubos::core::ecs::Write;
+using cubos::engine::Cubos;
+using cubos::engine::DeltaTime;
+
+using namespace tesseratos;
+
+namespace
+{
+    struct Metrics
+    {
+        float timeElapsed = 0.0F;
+        float fps = 0.0F;
+        float maxFps = 0.0F;
+        float avgFps;
+        // FPSGraph related
+        std::vector<float> timeHistory;
+        std::vector<float> fpsHistory;
+        const float timeSample = -5.0F;
+        const float fpsSample = 1000.0F;
+    };
+} // namespace
+
+static void showMetricsSystem(Read<DeltaTime> deltaTime, Write<Metrics> metrics)
+{
+    ImGui::Begin("Metrics Panel");
+    // General Metrics
+    metrics->timeElapsed += deltaTime->value;
+    metrics->fps = 1 / deltaTime->value;
+
+    for (unsigned int i = 0; i < metrics->timeHistory.size(); i++)
+    {
+        metrics->timeHistory[i] -= deltaTime->value;
+        if (metrics->timeHistory[i] <= metrics->timeSample)
+        {
+            metrics->timeHistory.erase(metrics->timeHistory.begin() + i);
+            metrics->fpsHistory.erase(metrics->fpsHistory.begin() + i);
+        }
+    }
+
+    // Add the current values to the history
+    metrics->timeHistory.push_back(0);
+    metrics->fpsHistory.push_back(metrics->fps);
+
+    ImGui::Text("Time: %.2f", metrics->timeElapsed);
+    // Plot the FPS history
+    if (ImPlot::BeginPlot("FPS Graph:"))
+    {
+        ImGui::Text("FPS: %.2f", metrics->fps);
+        ImPlot::SetupAxes("Time", "FPS",
+                          ImPlotAxisFlags_NoGridLines | ImPlotAxisFlags_Lock | ImPlotAxisFlags_NoDecorations,
+                          ImPlotAxisFlags_NoGridLines | ImPlotAxisFlags_Lock | ImPlotAxisFlags_NoDecorations);
+        ImPlot::SetupAxesLimits(metrics->timeSample, 0.0F, 0.0F, metrics->fpsSample, ImPlotCond_Always);
+        ImPlot::SetNextFillStyle(ImVec4(0, 0, 0, -1), 0.0F);
+        ImPlot::PlotLine("FPS Graph", metrics->timeHistory.data(), metrics->fpsHistory.data(),
+                         static_cast<int>(metrics->timeHistory.size()), ImPlotFlags_CanvasOnly | ImPlotFlags_NoInputs);
+        // This dont work return inf and -inf respectivl; Actuallly it might work
+        ImGui::TextColored(ImVec4(1.0F, 0.0F, 0.0F, 1.0F), "Max: %.2f",
+                           *std::max_element(metrics->fpsHistory.begin(), metrics->fpsHistory.end()));
+        ImGui::TextColored(ImVec4(1.0F, 1.0F, 0.0F, 1.0F), "Avg: %.2f",
+                           (std::accumulate(metrics->fpsHistory.begin(), metrics->fpsHistory.end(), 0.0F) /
+                            static_cast<float>(metrics->fpsHistory.size())));
+        ImPlot::EndPlot();
+    }
+    ImGui::End();
+}
+
+void tesseratos::metricsPanelPlugin(Cubos& cubos)
+{
+    cubos.addPlugin(cubos::engine::imguiPlugin);
+    cubos.addResource<Metrics>();
+    cubos.system(showMetricsSystem).tagged("cubos.imgui");
+}

tools/tesseratos/src/tesseratos/plugin.cpp

@@ -1,6 +1,7 @@
 #include <tesseratos/asset_explorer/plugin.hpp>
 #include <tesseratos/debug_camera/plugin.hpp>
 #include <tesseratos/entity_inspector/plugin.hpp>
+#include <tesseratos/metrics_panel/plugin.hpp>
 #include <tesseratos/plugin.hpp>
 #include <tesseratos/scene_editor/plugin.hpp>
 #include <tesseratos/settings_inspector/plugin.hpp>
@@ -16,4 +17,5 @@ void tesseratos::plugin(cubos::engine::Cubos& cubos)
     cubos.addPlugin(assetExplorerPlugin);
     cubos.addPlugin(debugCameraPlugin);
     cubos.addPlugin(settingsInspectorPlugin);
+    cubos.addPlugin(metricsPanelPlugin);
 }