DebugDraw.h

Go to the documentation of this file.

// DebugDraw.h
// File: DebugDraw.h
// Description: A system to collect lines and render them all at once each frame for debug information. recommended uses
// are hitboxes, paths, relationships, grids, and vectors.
// Author(s): Aidan Hartman (aidan.hartman@digipen.edu)
// 2025 / 11 / 07
// (C) Digipen 2025
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
 
#pragma once
 
// true or false
#ifdef _DEBUG
#define DEBUG_DRAW_START_ACTIVE true
#else
#define DEBUG_DRAW_START_ACTIVE false
#endif
 
#include "Framework/System.h"
#include "Graphics/VAO.h"
 
namespace gfx
{
class Line;
}
 

// namespace gfx
// {
// struct Vertex;
// }
#include "Graphics/Vertex.h"
 
namespace sys
{
class DebugDraw : public System
{
public:
#pragma region static_functions

    static auto getEnum() -> Type
    {
        return Type::DebugDraw;
    }

    static auto drawLine(const gfx::Line& line) -> void;
 
 
#pragma endregion
 
    DebugDraw();
    ~DebugDraw() override             = default;
    DebugDraw(const DebugDraw& other) = default;
    DebugDraw(DebugDraw&& other) noexcept;
    auto operator=(const DebugDraw& other) -> DebugDraw&;
    auto operator=(DebugDraw&& other) noexcept -> DebugDraw& = default;
 
 
#pragma region overridden_functions
 
    auto clone() const -> std::unique_ptr<GameObject> override
    {
        return std::make_unique<DebugDraw>(*this);
    }
 
    auto onUpdate(float dt) -> void override;
    auto onRender() -> void override;
 
protected:
    auto systemShowMenu() -> void override;
 
public:
    auto load(const Stream& stream) -> void override;
    auto save(Stream& stream) const -> void override;
    auto endWindow() -> void override;
 
#pragma endregion
 
#pragma region DebugDraw_Functions
 

    auto addLine(const gfx::Line& line) -> void;
 
 
#pragma endregion
 
private:
#pragma region member_variables
 
    std::shared_ptr<gfx::VertexBuffer> vertexBuffer;
    std::vector<std::pair<gfx::Vertex, gfx::Vertex>> lines;
    bool active{DEBUG_DRAW_START_ACTIVE};
 
    int lineWidth{2};
 
 
#pragma endregion
 
#pragma region helper_functions
    auto setupMesh() -> GLuint;
 
#pragma endregion
 
#pragma region static_variables
 
#pragma endregion
 
 
};
}

auto operator<<(sys::DebugDraw* debug, const gfx::Line& line) -> sys::DebugDraw*;
 
#undef DEBUG_DRAW_START_ACTIVE