UPBGE: Refactor debug shape and text drawing.

Two problems existed in the source managin the debug draw of texts
and lines, cube etc… :

- The text were draft directly when Render2DText was called.
  But this suppose that the OpenGL state have to be changed before the
  text render and have to be restored after the render.
  The same appeared for the 2d box render.

- The debug shapes were stored in a private subclass of RAS_IRasterizer
  per scene, so every push of a debug lines needed to pass the scene
  pointer and the rasterizer needed to find the proper debug shape
  list. This can cost a lot when the push could share a statement.

To fix these issue the first step was to create a special independant
class managing only the debug shapes, this class is named RAS_DebugDraw.
Its goal is to store the debug shapes but also to draw them using an
interface named RAS_OpenGLDebugDraw for all the OpenGL calls.

The rasterizer contains a list of all the debug drawer per scene, they
are get through the function GetDebugDraw. Once this, the push of
shapes is made as before but in the debug drawer instead of the rasterizer.

The 2D texts and boxes are now stored into the debug drawer to do one
OpenGL state switch before render them all and share the viewport settings.
To do this the functions RenderText2D and RenderBox2D are moved in RAS_DebugDraw.
In the same time the shadow is generalized by removing the "mode" argument
and using BLF_SHADOW mode for the text draw.

The flush function is a bit modified, it is renamed FlushDebugDraw and
need a canvas to be passed, this canvas is used to compute the viewport and
camera projection for 2D texts and boxes.

This refactor optimized the text render time of 31% (previous 0.81ms, now 0.56ms).

Author: panzergame

source/gameengine/Converter/BL_ArmatureObject.cpp

@@ -53,6 +53,8 @@ extern "C" {
 #include "KX_Globals.h"
 #include "KX_KetsjiEngine.h"
 
+#include "RAS_DebugDraw.h"
+
 #include "EXP_ListWrapper.h"
 
 #include "MT_Matrix4x4.h"
@@ -572,7 +574,7 @@ bool BL_ArmatureObject::GetDrawDebug() const
 	return m_drawDebug;
 }
 
-void BL_ArmatureObject::DrawDebugArmature()
+void BL_ArmatureObject::DrawDebug(RAS_DebugDraw& debugDraw)
 {
 	const MT_Vector3& scale = NodeGetWorldScaling();
 	const MT_Matrix3x3& rot = NodeGetWorldOrientation();
@@ -581,7 +583,7 @@ void BL_ArmatureObject::DrawDebugArmature()
 	for (bPoseChannel *pchan = (bPoseChannel *)m_pose->chanbase.first; pchan; pchan = pchan->next) {
 		MT_Vector3 head = rot * (MT_Vector3(pchan->pose_head) * scale) + pos;
 		MT_Vector3 tail = rot * (MT_Vector3(pchan->pose_tail) * scale) + pos;
-		KX_RasterizerDrawDebugLine(tail, head, MT_Vector4(1.0f, 0.0f, 0.0f, 1.0f));
+		debugDraw.DrawLine(tail, head, MT_Vector4(1.0f, 0.0f, 0.0f, 1.0f));
 	}
 	m_drawDebug = false;
 }

source/gameengine/Converter/BL_ArmatureObject.h

@@ -43,6 +43,7 @@ struct bConstraint;
 struct Object;
 class MT_Matrix4x4;
 class KX_BlenderSceneConverter;
+class RAS_DebugDraw;
 
 class BL_ArmatureObject : public KX_GameObject
 {
@@ -107,7 +108,7 @@ class BL_ArmatureObject : public KX_GameObject
 	Object *GetOrigArmatureObject();
 	int GetVertDeformType();
 	bool GetDrawDebug() const;
-	void DrawDebugArmature();
+	void DrawDebug(RAS_DebugDraw& debugDraw);
 
 	// for constraint python API
 	void LoadConstraints(KX_BlenderSceneConverter *converter);

source/gameengine/Ketsji/KX_Globals.cpp

@@ -85,11 +85,11 @@ const std::string& KX_GetOrigPath()
 
 void KX_RasterizerDrawDebugLine(const MT_Vector3& from,const MT_Vector3& to,const MT_Vector4& color)
 {
-	g_engine->GetRasterizer()->DrawDebugLine(g_scene, from, to, color);
+	g_engine->GetRasterizer()->GetDebugDraw(g_scene).DrawLine(from, to, color);
 }
 
 void KX_RasterizerDrawDebugCircle(const MT_Vector3& center, const MT_Scalar radius, const MT_Vector4& color,
                                   const MT_Vector3& normal, int nsector)
 {
-	g_engine->GetRasterizer()->DrawDebugCircle(g_scene, center, radius, color, normal, nsector);
+	g_engine->GetRasterizer()->GetDebugDraw(g_scene).DrawCircle(center, radius, color, normal, nsector);
 }

source/gameengine/Ketsji/KX_KetsjiEngine.cpp

@@ -1024,10 +1024,11 @@ void KX_KetsjiEngine::RenderFrame(KX_Scene *scene, KX_Camera *cam, RAS_OffScreen
 	m_logger->StartLog(tc_rasterizer, m_kxsystem->GetTimeInSeconds(), true);
 	SG_SetActiveStage(SG_STAGE_RENDER);
 
+	RAS_DebugDraw& debugDraw = m_rasterizer->GetDebugDraw(scene);
 	// Draw debug infos like bouding box, armature ect.. if enabled.
-	scene->DrawDebug(m_rasterizer);
+	scene->DrawDebug(debugDraw);
 	// Draw debug camera frustum.
-	DrawDebugCameraFrustum(scene, viewport, area);
+	DrawDebugCameraFrustum(scene, debugDraw, viewport, area);
 
 #ifdef WITH_PYTHON
 	PHY_SetActiveEnvironment(scene->GetPhysicsEnvironment());
@@ -1048,7 +1049,7 @@ RAS_OffScreen *KX_KetsjiEngine::PostRenderScene(KX_Scene *scene, RAS_OffScreen *
 {
 	KX_SetActiveScene(scene);
 
-	m_rasterizer->FlushDebugShapes(scene);
+	m_rasterizer->FlushDebugDraw(scene, m_canvas);
 
 	// We need to first make sure our viewport is correct (enabling multiple viewports can mess this up), only for filters.
 	const int width = m_canvas->GetWidth();
@@ -1066,7 +1067,7 @@ RAS_OffScreen *KX_KetsjiEngine::PostRenderScene(KX_Scene *scene, RAS_OffScreen *
 	scene->RunDrawingCallbacks(KX_Scene::POST_DRAW, nullptr);
 
 	// Python draw callback can also call debug draw functions, so we have to clear debug shapes.
-	m_rasterizer->FlushDebugShapes(scene);
+	m_rasterizer->FlushDebugDraw(scene, m_canvas);
 #endif
 
 	return offScreen;
@@ -1159,14 +1160,15 @@ void KX_KetsjiEngine::RenderDebugProperties()
 		tottime = 1e-6f;
 	}
 
+	static const MT_Vector4 white(1.0f, 1.0f, 1.0f, 1.0f);
+
+	// Use nullptrfor no scene.
+	RAS_DebugDraw& debugDraw = m_rasterizer->GetDebugDraw(nullptr);
+
 	if (m_show_framerate || m_show_profile) {
 		// Title for profiling("Profile")
-		m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-		                           "Profile",
-		                           xcoord + const_xindent + title_xmargin,  // Adds the constant x indent (0 for now) to the title x margin
-		                           ycoord,
-		                           m_canvas->GetWidth() /* RdV, TODO ?? */,
-		                           m_canvas->GetHeight() /* RdV, TODO ?? */);
+		// Adds the constant x indent (0 for now) to the title x margin
+		debugDraw.RenderText2D("Profile", MT_Vector2(xcoord + const_xindent + title_xmargin, ycoord), white);
 
 		// Increase the indent by default increase
 		ycoord += const_ysize;
@@ -1176,44 +1178,28 @@ void KX_KetsjiEngine::RenderDebugProperties()
 
 	// Framerate display
 	if (m_show_framerate) {
-		m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-		                           "Frametime :",
-		                           xcoord + const_xindent,
-		                           ycoord,
-		                           m_canvas->GetWidth() /* RdV, TODO ?? */,
-		                           m_canvas->GetHeight() /* RdV, TODO ?? */);
+		debugDraw.RenderText2D("Frametime :",
+		                           MT_Vector2(xcoord + const_xindent,
+		                           ycoord), white);
 
 		debugtxt = (boost::format("%5.2fms (%.1ffps)") %  (tottime * 1000.0f) % (1.0f / tottime)).str();
-		m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-		                           debugtxt,
-		                           xcoord + const_xindent + profile_indent,
-		                           ycoord,
-		                           m_canvas->GetWidth() /* RdV, TODO ?? */,
-		                           m_canvas->GetHeight() /* RdV, TODO ?? */);
+		debugDraw.RenderText2D(debugtxt, MT_Vector2(xcoord + const_xindent + profile_indent, ycoord), white);
 		// Increase the indent by default increase
 		ycoord += const_ysize;
 	}
 
 	// Profile display
 	if (m_show_profile) {
 		for (int j = tc_first; j < tc_numCategories; j++) {
-			m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-			                           m_profileLabels[j],
-			                           xcoord + const_xindent,
-			                           ycoord,
-			                           m_canvas->GetWidth(),
-			                           m_canvas->GetHeight());
+			debugDraw.RenderText2D(m_profileLabels[j], MT_Vector2(xcoord + const_xindent, ycoord), white);
 
 			double time = m_logger->GetAverage((KX_TimeCategory)j);
 
 			debugtxt = (boost::format("%5.2fms | %d%%") % (time*1000.f) % (int)(time/tottime * 100.f)).str();
-			m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-			                           debugtxt,
-			                           xcoord + const_xindent + profile_indent, ycoord,
-			                           m_canvas->GetWidth(),
-			                           m_canvas->GetHeight());
+			debugDraw.RenderText2D(debugtxt, MT_Vector2(xcoord + const_xindent + profile_indent, ycoord), white);
 
-			m_rasterizer->RenderBox2D(xcoord + (int)(2.2 * profile_indent), ycoord, m_canvas->GetWidth(), m_canvas->GetHeight(), time/tottime);
+			const MT_Vector2 boxSize(50 * (time / tottime), 10);
+			debugDraw.RenderBox2D(MT_Vector2(xcoord + (int)(2.2 * profile_indent), ycoord), boxSize, white);
 			ycoord += const_ysize;
 		}
 	}
@@ -1222,14 +1208,9 @@ void KX_KetsjiEngine::RenderDebugProperties()
 
 	/* Property display */
 	if (m_show_debug_properties) {
-
-		/* Title for debugging("Debug properties") */
-		m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-		                           "Debug Properties",
-		                           xcoord + const_xindent + title_xmargin,  // Adds the constant x indent (0 for now) to the title x margin
-		                           ycoord,
-		                           m_canvas->GetWidth() /* RdV, TODO ?? */,
-		                           m_canvas->GetHeight() /* RdV, TODO ?? */);
+		// Title for debugging("Debug properties")
+		// Adds the constant x indent (0 for now) to the title x margin
+		debugDraw.RenderText2D("Debug Properties", MT_Vector2(xcoord + const_xindent + title_xmargin, ycoord), white);
 
 		// Increase the indent by default increase
 		ycoord += const_ysize;
@@ -1265,41 +1246,33 @@ void KX_KetsjiEngine::RenderDebugProperties()
 							first = false;
 						}
 					}
-					m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-					                           debugtxt,
-					                           xcoord + const_xindent,
-					                           ycoord,
-					                           m_canvas->GetWidth(),
-					                           m_canvas->GetHeight());
+					debugDraw.RenderText2D(debugtxt, MT_Vector2(xcoord + const_xindent, ycoord), white);
 					ycoord += const_ysize;
 				}
 				else {
 					CValue *propval = propobj->GetProperty(propname);
 					if (propval) {
 						std::string text = propval->GetText();
 						debugtxt = objname + ": '" + propname + "' = " + text;
-						m_rasterizer->RenderText2D(RAS_IRasterizer::RAS_TEXT_PADDED,
-						                           debugtxt,
-						                           xcoord + const_xindent,
-						                           ycoord,
-						                           m_canvas->GetWidth(),
-						                           m_canvas->GetHeight());
+						debugDraw.RenderText2D(debugtxt, MT_Vector2(xcoord + const_xindent, ycoord), white);
 						ycoord += const_ysize;
 					}
 				}
 			}
 		}
 	}
+
+	m_rasterizer->FlushDebugDraw(nullptr, m_canvas);
 }
 
-void KX_KetsjiEngine::DrawDebugCameraFrustum(KX_Scene *scene, const RAS_Rect& viewport, const RAS_Rect& area)
+void KX_KetsjiEngine::DrawDebugCameraFrustum(KX_Scene *scene, RAS_DebugDraw& debugDraw, const RAS_Rect& viewport, const RAS_Rect& area)
 {
 	CListValue *cameras = scene->GetCameraList();
 	for (CListValue::iterator<KX_Camera> it = cameras->GetBegin(), end = cameras->GetEnd(); it != end; ++it) {
 		KX_Camera *cam = *it;
 		if (cam->GetShowCameraFrustum()) {
 			const MT_Matrix4x4 viewmat(cam->GetWorldToCamera());
-			m_rasterizer->DrawDebugCameraFrustum(scene, GetCameraProjectionMatrix(scene, cam, viewport, area), viewmat);
+			debugDraw.DrawCameraFrustum(GetCameraProjectionMatrix(scene, cam, viewport, area), viewmat);
 		}
 	}
 }

source/gameengine/Ketsji/KX_KetsjiEngine.h

@@ -232,7 +232,7 @@ class KX_KetsjiEngine
 	RAS_OffScreen *PostRenderScene(KX_Scene *scene, RAS_OffScreen *inputofs, RAS_OffScreen *targetofs);
 	void RenderDebugProperties();
 	/// Debug draw cameras frustum of a scene.
-	void DrawDebugCameraFrustum(KX_Scene *scene, const RAS_Rect& viewport, const RAS_Rect& area);
+	void DrawDebugCameraFrustum(KX_Scene *scene, RAS_DebugDraw& debugDraw, const RAS_Rect& viewport, const RAS_Rect& area);
 
 public:
 	KX_KetsjiEngine(KX_ISystem *system);

source/gameengine/Ketsji/KX_PythonInit.cpp

@@ -1193,15 +1193,14 @@ static PyObject *gPyDrawLine(PyObject *, PyObject *args)
 
 	// Allow conversion from vector 3d.
 	if (PyVecTo(ob_color, color3)) {
-		KX_GetActiveEngine()->GetRasterizer()->DrawDebugLine(KX_GetActiveScene(), from, to,
-															 MT_Vector4(color3.x(), color3.y(), color3.z(), 1.0f));
+		KX_RasterizerDrawDebugLine(from, to, MT_Vector4(color3.x(), color3.y(), color3.z(), 1.0f));
 		Py_RETURN_NONE;
 	}
 	else {
 		// Clear error message of the conversion from vector3d.
 		PyErr_Clear();
 		if (PyVecTo(ob_color, color4)) {
-			KX_GetActiveEngine()->GetRasterizer()->DrawDebugLine(KX_GetActiveScene(), from, to, color4);
+			KX_RasterizerDrawDebugLine(from, to, color4);
 		}
 		Py_RETURN_NONE;
 	}

source/gameengine/Ketsji/KX_Scene.cpp

@@ -1459,7 +1459,7 @@ void KX_Scene::CalculateVisibleMeshes(RAS_IRasterizer* rasty,KX_Camera* cam, int
 	}
 }
 
-void KX_Scene::DrawDebug(RAS_IRasterizer *rasty)
+void KX_Scene::DrawDebug(RAS_DebugDraw& debugDraw)
 {
 	const bool showBoundingBox = KX_GetActiveEngine()->GetShowBoundingBox();
 	if (showBoundingBox) {
@@ -1473,17 +1473,17 @@ void KX_Scene::DrawDebug(RAS_IRasterizer *rasty)
 				const SG_BBox& box = gameobj->GetSGNode()->BBox();
 				const MT_Vector3& center = box.GetCenter();
 
-				rasty->DrawDebugAabb(this, position, orientation, box.GetMin() * scale, box.GetMax() * scale,
+				debugDraw.DrawAabb(position, orientation, box.GetMin() * scale, box.GetMax() * scale,
 					MT_Vector4(1.0f, 0.0f, 1.0f, 1.0f));
 
 				// Render center in red, green and blue.
-				rasty->DrawDebugLine(this, orientation * center * scale + position,
+				debugDraw.DrawLine(orientation * center * scale + position,
 					orientation * (center + MT_Vector3(1.0f, 0.0f, 0.0f)) * scale + position,
 					MT_Vector4(1.0f, 0.0f, 0.0f, 1.0f));
-				rasty->DrawDebugLine(this, orientation * center * scale + position,
+				debugDraw.DrawLine(orientation * center * scale + position,
 					orientation * (center + MT_Vector3(0.0f, 1.0f, 0.0f)) * scale  + position,
 					MT_Vector4(0.0f, 1.0f, 0.0f, 1.0f));
-				rasty->DrawDebugLine(this, orientation * center * scale + position,
+				debugDraw.DrawLine(orientation * center * scale + position,
 					orientation * (center + MT_Vector3(0.0f, 0.0f, 1.0f)) * scale  + position,
 					MT_Vector4(0.0f, 0.0f, 1.0f, 1.0f));
 			}
@@ -1495,7 +1495,7 @@ void KX_Scene::DrawDebug(RAS_IRasterizer *rasty)
 		if (gameobj->GetGameObjectType() == SCA_IObject::OBJ_ARMATURE) {
 			BL_ArmatureObject *armature = (BL_ArmatureObject *)gameobj;
 			if (armature->GetDrawDebug() || KX_GetActiveEngine()->GetShowArmatures()) {
-				armature->DrawDebugArmature();
+				armature->DrawDebug(debugDraw);
 			}
 		}
 	}

source/gameengine/Ketsji/KX_Scene.h

@@ -79,6 +79,7 @@ class RAS_BucketManager;
 class RAS_MaterialBucket;
 class RAS_IPolyMaterial;
 class RAS_IRasterizer;
+class RAS_DebugDraw;
 class RAS_OffScreen;
 class RAS_2DFilterManager;
 class KX_2DFilterManager;
@@ -483,7 +484,7 @@ class KX_Scene : public CValue, public SCA_IScene
 	void SetWorldInfo(class KX_WorldInfo* wi);
 	KX_WorldInfo* GetWorldInfo();
 	void CalculateVisibleMeshes(RAS_IRasterizer* rasty, KX_Camera *cam, int layer=0);
-	void DrawDebug(RAS_IRasterizer *rasty);
+	void DrawDebug(RAS_DebugDraw& debugDraw);
 	KX_Camera* GetpCamera();
 	KX_BlenderSceneConverter *GetSceneConverter() { return m_sceneConverter; }
 

source/gameengine/Rasterizer/CMakeLists.txt

@@ -60,6 +60,7 @@ set(SRC
 	RAS_BoundingBox.cpp
 	RAS_BoundingBoxManager.cpp
 	RAS_BucketManager.cpp
+	RAS_DebugDraw.cpp
 	RAS_DisplayArrayBucket.cpp
 	RAS_FramingManager.cpp
 	RAS_ICanvas.cpp
@@ -90,6 +91,7 @@ set(SRC
 	RAS_BoundingBoxManager.h
 	RAS_BucketManager.h
 	RAS_CameraData.h
+	RAS_DebugDraw.h
 	RAS_Deformer.h
 	RAS_DisplayArray.h
 	RAS_DisplayArrayBucket.h