client: initial draft implementation of debug visualizer

Author: SNMetamorph

client/CMakeLists.txt

@@ -40,6 +40,7 @@ list(APPEND CLDLL_SOURCES
 	"postfx_parameters.cpp"
 	"client_weapon_layer_impl.cpp"
 	"weapon_predicting_context.cpp"
+	"visualizer/debug_visualizer.cpp"
 )
 
 # shared source files

client/visualizer/debug_visualizer.cpp

@@ -0,0 +1,65 @@
+/*
+debug_visualizer.cpp - utilities for visualizing data for debug purposes
+Copyright (C) 2025 SNMetamorph
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program 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.
+*/
+
+#include "debug_visualizer.h"
+#include "hud.h"
+
+CDebugVisualizer::Primitive::Primitive(Class type, Vector color, std::optional<float> lifespan, bool depthTest, DataVariant data) :
+	type(type),
+	color(color),
+	lifespan(lifespan),
+	depthTest(depthTest),
+	rendered(false), 
+	data(std::move(data)) 
+{
+}
+
+CDebugVisualizer& CDebugVisualizer::GetInstance()
+{
+	static CDebugVisualizer instance;
+	return instance;
+}
+
+void CDebugVisualizer::RunFrame()
+{
+	float currentTime = gEngfuncs.GetClientTime();
+	auto predicate = [currentTime](const Primitive& prim) {
+		if (prim.lifespan.has_value()) {
+			return currentTime >= prim.lifespan.value();
+		}
+		return prim.rendered;
+	};
+	m_primitives.erase(std::remove_if(m_primitives.begin(), m_primitives.end(), predicate), m_primitives.end());
+}
+
+void CDebugVisualizer::DrawAABB(const Vector &mins, const Vector &maxs, Vector color, std::optional<float> lifespan, bool depthTest)
+{
+	m_primitives.emplace_back(Primitive::Class::AABB, color, lifespan, depthTest, AABBData{ mins, maxs });
+}
+
+void CDebugVisualizer::DrawSphere(const Vector &center, float radius, Vector color, std::optional<float> lifespan, bool depthTest)
+{
+	m_primitives.emplace_back(Primitive::Class::Sphere, color, lifespan, depthTest, SphereData{ center, radius });
+}
+
+void CDebugVisualizer::DrawVector(const Vector &position, const Vector &direction, Vector color, std::optional<float> lifespan, bool depthTest)
+{
+	m_primitives.emplace_back(Primitive::Class::Vector, color, lifespan, depthTest, VectorData{ position, direction });
+}
+
+void CDebugVisualizer::DrawFrustum(const CFrustum &frustum, Vector color, std::optional<float> lifespan, bool depthTest)
+{
+	m_primitives.emplace_back(Primitive::Class::Frustum, color, lifespan, depthTest, FrustumData{ frustum });
+}

client/visualizer/debug_visualizer.h

@@ -0,0 +1,73 @@
+/*
+debug_visualizer.h - utilities for visualizing data for debug purposes
+Copyright (C) 2025 SNMetamorph
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program 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 "vector.h"
+#include "frustum.h"
+#include <vector>
+#include <optional>
+#include <variant>
+
+class CDebugVisualizer
+{
+public:
+	struct AABBData { Vector mins, maxs; };
+	struct SphereData { Vector center; float radius; };
+	struct VectorData { Vector position, direction; };
+	struct FrustumData { CFrustum frustum; };
+
+	class Primitive
+	{
+	public:
+		using DataVariant = std::variant<AABBData, SphereData, VectorData, FrustumData>;
+
+		enum class Class
+		{
+			AABB,
+			Sphere,
+			Vector,
+			Frustum,
+		};
+
+		Primitive(Class type, Vector color, std::optional<float> lifespan, bool depthTest, DataVariant data);
+
+		Class type;
+		bool depthTest;
+		bool rendered;
+		Vector color;
+		std::optional<float> lifespan;
+		DataVariant data;
+	};
+
+	static CDebugVisualizer& GetInstance();
+	const std::vector<Primitive>& GetPrimitives() const { return m_primitives; }
+	void RunFrame();
+
+	void DrawAABB(const Vector &mins, const Vector &maxs, Vector color, std::optional<float> lifespan, bool depthTest);
+	void DrawSphere(const Vector &center, float radius, Vector color, std::optional<float> lifespan, bool depthTest);
+	void DrawVector(const Vector &position, const Vector& direction, Vector color, std::optional<float> lifespan, bool depthTest);
+	void DrawFrustum(const CFrustum &frustum, Vector color, std::optional<float> lifespan, bool depthTest);
+	// ...and other geometric primitives as needed
+
+private:
+	CDebugVisualizer() = default;
+	~CDebugVisualizer() = default;
+	CDebugVisualizer(const CDebugVisualizer&) = delete;
+	CDebugVisualizer(CDebugVisualizer&&) = delete;
+	CDebugVisualizer& operator=(const CDebugVisualizer&) = delete;
+	CDebugVisualizer& operator=(CDebugVisualizer&&) = delete;
+
+	std::vector<Primitive> m_primitives;
+};