debug_draw_2d.h

#pragma once
 
#include "common/colors.h"
#include "utils/compiler.h"
 
#include <memory>
 
GODOT_WARNING_DISABLE()
#include <godot_cpp/classes/control.hpp>
#include <godot_cpp/classes/font.hpp>
GODOT_WARNING_RESTORE()
using namespace godot;
 
class DataGraphManager;
class DebugDrawManager;
class DebugDraw2DConfig;
class DebugDraw2DGraph;
class DebugDraw2DStats;
class GroupedText;
 
class DebugDraw2D : public Object {
    GDCLASS(DebugDraw2D, Object)
 
    friend DebugDrawManager;
    static DebugDraw2D *singleton;
 
private:
    DebugDrawManager *root_node = nullptr;
 
    // 2d
    const static char *s_marked_dirty;
 
    bool _is_drawing_frame = true;
    bool _canvas_need_update = true;
    Ref<Font> _font;
    Ref<DebugDraw2DStats> stats_2d;
 
    Callable call_canvas_item_draw_cache;
    uint64_t default_control_id = 0;
 
#ifndef DISABLE_DEBUG_RENDERING
    std::unique_ptr<GroupedText> grouped_text;
    std::unique_ptr<DataGraphManager> data_graphs;
#endif
 
#ifndef DISABLE_DEBUG_RENDERING
    void _finish_frame_and_update();
    void _clear_all_internal();
    void _set_custom_canvas_internal(Control *_canvas);
#endif
 
    void _on_canvas_item_draw(Control *ci);
    inline bool _is_enabled_override() const;
 
    void process_start(double delta);
    void process_end(double delta);
    void physics_process_start(double delta);
    void physics_process_end(double delta);
 
#pragma region Exposed Parameter Values
 
    // GENERAL
 
    bool debug_enabled = true;
    uint64_t custom_control_id = 0;
 
    Ref<DebugDraw2DConfig> config;
 
#pragma endregion // Exposed Parameter Values
 
protected:
    static void _bind_methods();
 
public:
    DebugDraw2D();
    ~DebugDraw2D();
 
    void init(DebugDrawManager *root);
 
    static DebugDraw2D *get_singleton() {
        return singleton;
    };
    void mark_canvas_dirty();
    bool is_drawing_frame() const;
 
    Node *get_root_node();
 
#pragma region Exposed Parameters
    void set_empty_color(const Color &_col);
    Color get_empty_color() const;
 
    void set_debug_enabled(const bool &_state);
    bool is_debug_enabled() const;
 
    void set_config(Ref<DebugDraw2DConfig> _cfg);
    Ref<DebugDraw2DConfig> get_config() const;
 
    void set_custom_canvas(Control *_canvas);
    Control *get_custom_canvas() const;
#pragma endregion // Exposed Parametes
 
#pragma region Exposed Draw Functions
 
    Ref<DebugDraw2DStats> get_render_stats();
 
    void clear_all();
 
#pragma region Text
    void begin_text_group(String group_title, int group_priority = 0, Color group_color = Colors::white_smoke, bool show_title = true, int title_size = 14, int text_size = 12);
    void end_text_group();
    void set_text(String key, Variant value = Variant(), int priority = 0, Color color_of_value = Colors::empty_color, real_t duration = -1);
 
    void clear_texts();
#pragma endregion // Text
#pragma region Graphs
 
    Ref<DebugDraw2DGraph> create_graph(const StringName &title);
 
    Ref<DebugDraw2DGraph> create_fps_graph(const StringName &title);
 
    void graph_update_data(const StringName &title, real_t data);
 
    void remove_graph(const StringName &title);
 
    void clear_graphs();
 
    Ref<DebugDraw2DGraph> get_graph(const StringName &title);
 
    PackedStringArray get_graph_names();
 
#pragma endregion // Graphs
#pragma endregion // Exposed Draw Functions
};