SystemDisplay.hpp File Reference

#include <Engine/RaEngine.hpp>
#include <Core/Utils/Color.hpp>
#include <Core/Utils/Singleton.hpp>
#include <Engine/Scene/Component.hpp>
#include <Engine/Scene/Entity.hpp>
#include <Engine/Data/DrawPrimitives.hpp>

Include dependency graph for SystemDisplay.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Ra::Engine::Scene::DebugComponent
	Component for debug drawing. More...
class	Ra::Engine::Scene::UiComponent
	Component for UI drawing. More...
class	Ra::Engine::Scene::SystemEntity

Namespaces
namespace	Ra
	hepler function to manage enum as underlying types in VariableSet
namespace	Ra::Engine
	This namespace contains engine and ECS related stuff.
namespace	Ra::Engine::Scene
	Scene and how to communicate.

Macros
#define	RA_DISPLAY_POINT(p, color, scale)
	Macros for debug drawing. All coordinates are in world space.
#define	RA_DISPLAY_VECTOR(p, v, color)
#define	RA_DISPLAY_RAY(r, color)
#define	RA_DISPLAY_CIRCLE(c, n, r, color)
#define	RA_DISPLAY_TRIANGLE(a, b, c, color)
#define	RA_DISPLAY_NORMAL(p, n, color, scale)
#define	RA_DISPLAY_FRAME(t, scale)
#define	RA_DISPLAY_AABB(a, color)
#define	RA_DISPLAY_OBB(a, color)
#define	RA_DISPLAY_SPHERE(c, r, color)
#define	RA_DISPLAY_CAPSULE(p1, p2, r, color)
#define	RA_DISPLAY_LINE(a, b, color)
#define	RA_CLEAR_DEBUG_DISPLAY()

Detailed Description

This file's main purpose is to declare a set of macros to allow drawing primitives from everywhere in the code, for debug purposes. These macros can be completely disabled by #defining the following constant :

Definition in file SystemDisplay.hpp.

Macro Definition Documentation

RA_CLEAR_DEBUG_DISPLAY

#define RA_CLEAR_DEBUG_DISPLAY

(

)

Value:

        {                                                           \
            auto cmp = Ra::Engine::Scene::SystemEntity::dbgCmp();   \
            while ( cmp->m_renderObjects.size() ) {                 \
                cmp->removeRenderObject( cmp->m_renderObjects[0] ); \
            }                                                       \
        }

Definition at line 149 of file SystemDisplay.hpp.

RA_DISPLAY_AABB

#define RA_DISPLAY_AABB	(		a,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::AABB( a, color ) ) )

Definition at line 119 of file SystemDisplay.hpp.

RA_DISPLAY_CAPSULE

#define RA_DISPLAY_CAPSULE	(		p1,
			p2,
			r,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Capsule( p1, p2, r, color ) ) )

Definition at line 137 of file SystemDisplay.hpp.

RA_DISPLAY_CIRCLE

#define RA_DISPLAY_CIRCLE	(		c,
			n,
			r,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Circle( c, n, r, 20, color ) ) )

Definition at line 95 of file SystemDisplay.hpp.

RA_DISPLAY_FRAME

#define RA_DISPLAY_FRAME	(		t,
			scale )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Frame( t, scale ) ) )

Definition at line 113 of file SystemDisplay.hpp.

RA_DISPLAY_LINE

#define RA_DISPLAY_LINE	(		a,
			b,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Line( a, b, color ) ) )

Definition at line 143 of file SystemDisplay.hpp.

RA_DISPLAY_NORMAL

#define RA_DISPLAY_NORMAL	(		p,
			n,
			color,
			scale )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Scene::DrawPrimitives::Primitive(           \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Scene::DrawPrimitives::Normal( p, n, color, scale ) ) )

Definition at line 107 of file SystemDisplay.hpp.

RA_DISPLAY_OBB

#define RA_DISPLAY_OBB	(		a,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::OBB( a, color ) ) )

Definition at line 125 of file SystemDisplay.hpp.

RA_DISPLAY_POINT

#define RA_DISPLAY_POINT	(		p,
			color,
			scale )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Point( p, color, scale ) ) )

Macros for debug drawing. All coordinates are in world space.

Definition at line 77 of file SystemDisplay.hpp.

RA_DISPLAY_RAY

#define RA_DISPLAY_RAY	(		r,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Ray( r, color ) ) )

Definition at line 89 of file SystemDisplay.hpp.

RA_DISPLAY_SPHERE

#define RA_DISPLAY_SPHERE	(		c,
			r,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Sphere( c, r, color ) ) )

Definition at line 131 of file SystemDisplay.hpp.

RA_DISPLAY_TRIANGLE

#define RA_DISPLAY_TRIANGLE	(		a,
			b,
			c,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::SystemEntity::dbgCmp(),                 \
                Ra::Engine::Data::DrawPrimitives::Triangle( a, b, c, color ) ) )

Definition at line 101 of file SystemDisplay.hpp.

RA_DISPLAY_VECTOR

#define RA_DISPLAY_VECTOR	(		p,
			v,
			color )

Value:

        Ra::Engine::Scene::SystemEntity::dbgCmp()->addRenderObject( \
            Ra::Engine::Data::DrawPrimitives::Primitive(            \
                Ra::Engine::Scene::SystemEntity::dbgCmp(),          \
                Ra::Engine::Data::DrawPrimitives::Vector( p, v, color ) ) )

Definition at line 83 of file SystemDisplay.hpp.