DebugDraw.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
 
#pragma once
 
#include <OgreHardwareVertexBuffer.h>
#include <OgreRenderQueueListener.h>
#include <OgreRoot.h>
#include <OgreSingleton.h>
#include <OgreFont.h>
 
class DebugDraw : public Ogre::RenderQueueListener, public Ogre::Singleton<DebugDraw>{
 
    public:
 
        DebugDraw();
 
        virtual ~DebugDraw();
 
        void SetColour(const Ogre::ColourValue& colour);
 
        void SetScreenSpace(const bool screen_space);
 
        void SetZ(const float z);
 
        void SetFadeDistance(const float fade_s, const float fade_e);
 
        enum TextAlignment{
 
            LEFT,
 
            RIGHT,
 
            CENTER
        };
        void SetTextAlignment(TextAlignment alignment);
 
        void Line(
          const float x1, const float y1, const float x2, const float y2
        );
 
        void Line3d(const Ogre::Vector3& point1, const Ogre::Vector3& point2);
 
        void Triangle3d(
          const Ogre::Vector3& point1, const Ogre::Vector3& point2,
          const Ogre::Vector3& point3
        );
 
        void Quad(
          const float x1, const float y1, const float x2, const float y2,
          const float x3, const float y3, const float x4, const float y4
        );
 
        void Text(const float x, const float y, const Ogre::String& text);
 
        void Text(
          const Ogre::Vector3& point, const float x, const float y,
          const Ogre::String& text
        );
 
        void renderQueueEnded(
          Ogre::uint8 queueGroupId, const Ogre::String& invocation,
          bool& repeatThisInvocation
        );
 
    private:
 
        void CreateLineVertexBuffer();
 
        void DestroyLineVertexBuffer();
 
        void CreateLine3dVertexBuffer();
 
        void DestroyLine3dVertexBuffer();
 
        void CreateTriangle3dVertexBuffer();
 
        void DestroyTriangle3dVertexBuffer();
 
        void CreateQuadVertexBuffer();
 
        void DestroyQuadVertexBuffer();
 
        void CreateTextVertexBuffer();
 
        void DestroyTextVertexBuffer();
 
        Ogre::SceneManager* scene_manager_;
 
        Ogre::RenderSystem* render_system_;
 
        Ogre::RenderOperation line_render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr line_vertex_buffer_;
 
        unsigned int line_max_vertex_;
 
        Ogre::RenderOperation line_3d_render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr line_3d_vertex_buffer_;
 
        unsigned int line_3d_max_vertex_;
 
        Ogre::RenderOperation triangle_3d_render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr triangle_3d_vertex_buffer_;
 
        unsigned int triangle_3d_max_vertex_;
 
        Ogre::RenderOperation quad_render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr quad_vertex_buffer_;
 
        unsigned int quad_max_vertex_;
 
        Ogre::RenderOperation text_render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr text_vertex_buffer_;
 
        unsigned int text_max_vertex_;
 
        Ogre::FontPtr font_;
 
        int font_height_;
 
        TextAlignment text_alignment_;
 
        Ogre::MaterialPtr material_;
 
        Ogre::MaterialPtr material_3d_;
 
        Ogre::ColourValue colour_;
 
        bool screen_space_;
 
        float z_coordinate_;
 
        float fade_start_square_;
 
        float fade_end_square_;
};
 
#define DEBUG_DRAW DebugDraw::getSingleton()