Archive 17/01/2023.

VisualDebugger Subsystem

TrevorCash

I found myself wanting a basic tool for quickly adding debug geometry to my scene at any time using a single call and then having it disappear automatically later after a delay. So I made a subsystem called VisualDebugger that wraps calls to DebugRenderer like DebugRenderer->AddLine(…) etc.

github.com

TrevorCash/Urho3D/blob/master/Source/Urho3D/Graphics/VisualDebugger.h

#ifndef VISUAL_DEBUGGER_H
#define VISUAL_DEBUGGER_H

#include "limits.h"

#include "../Core/Object.h"
#include "../Core/Timer.h"
#include "../Container/List.h"
#include "../Math/Sphere.h"
#include "../Math/Polyhedron.h"
#include "../Math/Frustum.h"
#include "../Math/Ray.h"
#include "../Scene/Node.h"

namespace Urho3D
{
	class DebugRenderer;
	class Camera;
	class Text;
	class Node;

This file has been truncated. show original

Initialization/setup:

RegisterSubsystem(new VisualDebugger(context_));

Specify camera for displaying labels in the world:

GetSubsystem<VisualDebugger>()->SetPrimaryCamera(camera);

In HandlePostRenderUpdate() Issue the draw call to draw all geometry:

GetSubsystem<VisualDebugger>()->DrawDebugGeometry(scene_->GetComponent<DebugRenderer>());

Example Usage anywhere:

VisualDebuggerUILabel* label = GetSubsystem<VisualDebugger>()->AddLabel(Vector3(0,0,0), “my debug label in the world”);

By default geometry will last 2 seconds until it is deleted.

This can be changed with a call to SetObjectLifeTimeMs() Or by calling label->SetLifeTimeMs() for individual control.

You can also restrict the max number of draw-able objects and/or the maximum time spent in the DrawDebugGeometry() call.

TrevorCash

This video shows how I use the visual debugger to debug the world generation sampling in GreatGame: