EngineDebugLayer.hpp

Go to the documentation of this file.

#pragma once
 
#include <deque>
 
#include "SD/core/ApplicationRuntime.hpp"
#include "SD/core/EngineServices.hpp"
#include "SD/core/Layer.hpp"
#include "SD/core/events/EventVariant.hpp"
#include "SD/core/logging.hpp"
#include "SD/export.hpp"
 
namespace sd {
 
struct Scene;
struct View;
 
struct SD_EXPORT EngineDebugLayer : Panel {
  EngineDebugLayer(ApplicationRuntime runtime, EngineServices services, Scene* scene = nullptr);
 
  void on_update(float dt);
  void on_fixed_update(double dt);
  void on_event(EventVariant& e);
  void on_im_gui_menu_bar();
  void on_gui_render();
 
 
  void display_view_info(View* selected_view);
  void display_scene_selector();
  void display_ecs_inspector();
  void display_event_log();
  void display_layout_menu();
  void display_save_layout_dialog();
  void display_delete_layout_dialog();
  void display_overwrite_confirmation_dialog();
  void handle_layout_shortcuts();
  void handle_debug_shortcuts();
 
  ApplicationRuntime make_runtime() {
    return ApplicationRuntime{
        .views              = m_views,
        .scenes             = m_scenes,
        .layout             = m_layout,
        .events             = m_events,
        .timer              = m_frame_timer,
        .global_layers      = m_global_layers,
        .hot_reload_enabled = m_hot_reload_enabled,
    };
  }
 
  ViewManager&    m_views;
  SceneManager&   m_scenes;
  LayoutManager&  m_layout;
  EventManager&   m_events;
  FrameTimer&     m_frame_timer;
  bool&           m_hot_reload_enabled;
  LayerList&      m_global_layers;
  VulkanRenderer& m_renderer;
 
  bool                 m_show_save_layout_dialog     = false;
  bool                 m_show_delete_layout_dialog   = false;
  bool                 m_show_overwrite_confirmation = false;
  bool                 m_save_dialog_initialized     = false;
  std::string          m_pending_layout_name;
  std::array<char, 64> m_layout_name_buffer{};
 
  bool m_show_view_inspector  = true;
  bool m_show_scene_inspector = true;
  bool m_show_event_log       = true;
  bool m_show_renderer_info   = true;
  bool m_show_context_overlay = false;
  void set_view_inspector_visible(bool visible) { m_show_view_inspector = visible; }
  void set_scene_inspector_visible(bool visible) { m_show_scene_inspector = visible; }
  void set_event_log_visible(bool visible) { m_show_event_log = visible; }
  void set_renderer_info_visible(bool visible) { m_show_renderer_info = visible; }
  void set_context_overlay_visible(bool visible) { m_show_context_overlay = visible; }
 
  bool is_view_inspector_visible() const { return m_show_view_inspector; }
  bool is_scene_inspector_visible() const { return m_show_scene_inspector; }
  bool is_event_log_visible() const { return m_show_event_log; }
  bool is_renderer_info_visible() const { return m_show_renderer_info; }
  bool is_context_overlay_visible() const { return m_show_context_overlay; }
 
  void apply_preset_configuration(bool inspectors_visible, bool log_visible, bool renderer_visible);
 
  bool m_log_events           = false;
  bool m_log_scene_changes    = false;
  bool m_log_view_resizes     = false;
  bool m_log_entity_lifecycle = false;
 
  char m_log_search_buffer[128]{};
  bool m_log_show_trace      = true;
  bool m_log_show_debug      = true;
  bool m_log_show_info       = true;
  bool m_log_show_warn       = true;
  bool m_log_show_error      = true;
  bool m_log_show_critical   = true;
  bool m_log_show_general    = true;
  bool m_log_show_timestamps = true;
 
  struct CategoryNode {
    std::string               name;
    std::string               full_path;
    bool                      visible = true;
    std::vector<CategoryNode> children;
  };
  CategoryNode m_category_root{"", "", true, {}};
  bool         m_category_tree_built = false;
 
  void build_category_tree();
  void render_category_node(CategoryNode& node);
  void render_category_menu(CategoryNode& node);
  bool is_log_visible(const std::string& category);
  void set_category_visible(CategoryNode& node, bool visible);
  bool is_log_entry_visible(const log::LogEntry& entry);
 
  float m_timer              = 0.0f;
  int   m_update_count       = 0;
  int   m_fixed_update_count = 0;
  int   m_prev_fixed         = 0;
  int   m_prev_update        = 0;
 
  Scene*                m_selected_scene = nullptr;
  std::optional<ViewId> m_selected_view_id;
 
  Scene* m_prev_scene_for_entity_count = nullptr;
  int    m_prev_entity_count           = -1;
};
 
} // namespace sd