DebugDraw.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
#include <glm/mat4x4.hpp>
#include <glm/vec3.hpp>
#include <glm/vec4.hpp>
#include <vector>
 
namespace Engine::Rendering
{
    class RenderProcess;
}  // namespace Engine::Rendering
 
namespace Engine::Debug::Rendering
{

    struct LineVertex
    {
        glm::vec3 position;  // 12 bytes
        glm::vec4 color;     // 16 bytes
    };  // Total: 28 bytes per vertex

    namespace Colors
    {
        constexpr glm::vec4 Red{ 1.0f, 0.0f, 0.0f, 1.0f };
        constexpr glm::vec4 Green{ 0.0f, 1.0f, 0.0f, 1.0f };
        constexpr glm::vec4 Blue{ 0.0f, 0.0f, 1.0f, 1.0f };
        constexpr glm::vec4 Yellow{ 1.0f, 1.0f, 0.0f, 1.0f };
        constexpr glm::vec4 Cyan{ 0.0f, 1.0f, 1.0f, 1.0f };
        constexpr glm::vec4 Magenta{ 1.0f, 0.0f, 1.0f, 1.0f };
        constexpr glm::vec4 White{ 1.0f, 1.0f, 1.0f, 1.0f };
        constexpr glm::vec4 Orange{ 1.0f, 0.5f, 0.0f, 1.0f };
    }  // namespace DebugColors

    class Draw
    {
    public:
        static void setEnabled( bool enabled );

        static bool isEnabled();
 
        // ========================================================================
        // Drawing Primitives
        // ========================================================================

        static void line(
            const glm::vec3 & start,
            const glm::vec3 & end,
            const glm::vec4 & color = Colors::White
        );

        static void arrow(
            const glm::vec3 & origin,
            const glm::vec3 & direction,
            const glm::vec4 & color    = Colors::White,
            float             headSize = 0.1f
        );

        static void vector(
            const glm::vec3 & origin,
            const glm::vec3 & vec,
            const glm::vec4 & color = Colors::White,
            float             scale = 1.0f
        );

        static void axes( const glm::vec3 & origin, float size = 1.0f );

        static void point(
            const glm::vec3 & position,
            float             size  = 0.05f,
            const glm::vec4 & color = Colors::White
        );

        static void
            box( const glm::vec3 & center,
                 const glm::vec3 & halfExtents,
                 const glm::vec4 & color = Colors::Green );

        static void
            box( const glm::mat4 & transform,
                 const glm::vec3 & halfExtents,
                 const glm::vec4 & color = Colors::Green );

        static void sphere(
            const glm::vec3 & center,
            float             radius,
            const glm::vec4 & color    = Colors::Green,
            int               segments = 16
        );

        static void capsule(
            const glm::mat4 & transform,
            float             radius,
            float             height,
            const glm::vec4 & color    = Colors::Green,
            int               segments = 16
        );

        static void convexHull(
            const std::vector<glm::vec3> & vertices,
            const glm::mat4 &              transform = glm::mat4( 1.0f ),
            const glm::vec4 &              color     = Colors::Cyan
        );

        static void triangleMesh(
            const std::vector<glm::vec3> & vertices,
            const std::vector<uint32_t> &  indices,
            const glm::mat4 &              transform = glm::mat4( 1.0f ),
            const glm::vec4 &              color     = Colors::Cyan
        );
 
        // ========================================================================
        // Internal API (called by Renderer)
        // ========================================================================

        static void beginFrame( Engine::Rendering::RenderProcess * renderProcess );

        static void setCurrentRenderProcess( Engine::Rendering::RenderProcess * renderProcess );

        static uint32_t getLineCount();
 
        static uint32_t getLastLineCount();
 
        static uint32_t getLineCapacity();
    private:
        static void addLine( const glm::vec3 & start, const glm::vec3 & end, const glm::vec4 & color );
 
        static bool                               enabled_;
        static Engine::Rendering::RenderProcess * currentRenderProcess_;
    };
}  // namespace Engine::Core::Debug