#5584: Some docs and comments

codereader · Jan 23, 2022 · 7f46ab0 · 7f46ab0
1 parent f9ca7d9
commit 7f46ab0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/include/irender.h b/include/irender.h
@@ -498,7 +498,7 @@ class IRenderableText
     // The position in world space where the text needs to be rendered
     virtual const Vector3& getWorldPosition() = 0;
 
-    // The text to be rendered
+    // The text to be rendered. Returning an empty text will skip this renderable.
     virtual const std::string& getText() = 0;
 
     // The colour of the text

diff --git a/radiantcore/rendersystem/backend/TextRenderer.h b/radiantcore/rendersystem/backend/TextRenderer.h
@@ -1,11 +1,18 @@
 #pragma once
 
+#include <map>
 #include "igl.h"
 #include "irender.h"
 
 namespace render
 {
 
+/**
+ * Text renderer implementation drawing the attached IRenderableText
+ * instances to the scene. Does not change any GL state/matrices.
+ * 
+ * Requires a valid IGLFont reference at construction time.
+ */
 class TextRenderer final :
     public ITextRenderer
 {

diff --git a/radiantcore/selection/manipulators/RotateManipulator.cpp b/radiantcore/selection/manipulators/RotateManipulator.cpp
@@ -139,6 +139,7 @@ void RotateManipulator::clearRenderables()
     _circleSphere.clear();
     _pivotPoint.clear();
     _angleText.clear();
+
     _lineShader.reset();
     _pivotPointShader.reset();
     _textRenderer.reset();