#5364: 'Override light colour' now working

If the checkbox is set, the LightNode::renderLightVolume() method uses the EntityNode::_wireShader shader instead of the shader exposed by ColourKey (which changes with the '_color' spawnarg).
codereader · Dec 22, 2020 · deaea8a · deaea8a
1 parent 10bbba2
commit deaea8a
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 44 deletions.
diff --git a/include/icolourscheme.h b/include/icolourscheme.h
@@ -7,6 +7,13 @@
 namespace colours
 {
 
+/**
+ * Registry key set when light volumes should be rendered in a single colour
+ * set by the colourscheme, rather than the colour contained in their _color
+ * key.
+ */
+constexpr const char* RKEY_OVERRIDE_LIGHTCOL = "user/ui/colour/overrideLightColour";
+
 class IColourItem
 {
 public:

diff --git a/radiant/uimanager/colourscheme/ColourSchemeEditor.cpp b/radiant/uimanager/colourscheme/ColourSchemeEditor.cpp
@@ -10,6 +10,7 @@
 #include "wxutil/dialog/MessageBox.h"
 #include "wxutil/TreeView.h"
 #include "registry/registry.h"
+#include "registry/Widgets.h"
 
 #include <wx/panel.h>
 #include <wx/sizer.h>
@@ -24,8 +25,6 @@ namespace ui
 namespace
 {
     const char* const EDITOR_WINDOW_TITLE = N_("Edit Colour Schemes");
-
-    constexpr const char* RKEY_OVERRIDE_LIGHTCOL = "user/ui/colour/overrideLightColour";
 }
 
 ColourSchemeEditor::ColourSchemeEditor() :
@@ -84,16 +83,7 @@ void ColourSchemeEditor::addOptionsPanel(wxBoxSizer& vbox)
     wxCheckBox* overrideLightsCB = new wxCheckBox(
         this, wxID_ANY, _("Override light volume colour")
     );
-    overrideLightsCB->SetValue(
-        registry::getValue(RKEY_OVERRIDE_LIGHTCOL, false)
-    );
-    overrideLightsCB->Bind(
-        wxEVT_CHECKBOX,
-        [this](wxCommandEvent& ev)
-        {
-            registry::setValue(RKEY_OVERRIDE_LIGHTCOL, ev.IsChecked());
-        }
-    );
+    registry::bindWidget(overrideLightsCB, colours::RKEY_OVERRIDE_LIGHTCOL);
 
     vbox.Add(overrideLightsCB, 0, wxEXPAND | wxTOP, 6);
 }

diff --git a/radiantcore/entity/ColourKey.h b/radiantcore/entity/ColourKey.h
@@ -56,10 +56,11 @@ class ColourKey :
 		captureShader();
 	}
 
-	const ShaderPtr& getWireShader() const
-	{
-		return _wireShader;
-	}
+    /// Return a non-owning (possibly null) pointer to the Shader
+    Shader* getWireShader() const
+    {
+        return _wireShader.get();
+    }
 
 private:
 

diff --git a/radiantcore/entity/EntityNode.cpp b/radiantcore/entity/EntityNode.cpp
@@ -308,16 +308,6 @@ std::size_t EntityNode::getHighlightFlags()
 	return isGroupMember() ? (Highlight::Selected | Highlight::GroupMember) : Highlight::Selected;
 }
 
-const Vector3& EntityNode::getColour() const
-{
-	return _colourKey.getColour();
-}
-
-const ShaderPtr& EntityNode::getColourShader() const
-{
-	return _colourKey.getWireShader();
-}
-
 ModelKey& EntityNode::getModelKey()
 {
 	return _modelKey;

diff --git a/radiantcore/entity/EntityNode.h b/radiantcore/entity/EntityNode.h
@@ -130,10 +130,6 @@ class EntityNode :
 	void addKeyObserver(const std::string& key, KeyObserver& observer);
 	void removeKeyObserver(const std::string& key, KeyObserver& observer);
 
-	// Returns the colour as defined in the _color spawnarg
-	const Vector3& getColour() const;
-	const ShaderPtr& getColourShader() const;
-
 	ModelKey& getModelKey(); // needed by the Doom3Group class, could be a fixme
     const ModelKey& getModelKey() const;
 

diff --git a/radiantcore/entity/light/LightNode.cpp b/radiantcore/entity/light/LightNode.cpp
@@ -1,9 +1,12 @@
 #include "LightNode.h"
 
 #include "itextstream.h"
+#include "icolourscheme.h"
 #include "../EntitySettings.h"
 #include <functional>
 
+#include "registry/CachedKey.h"
+
 namespace entity {
 
 // --------- LightNode implementation ------------------------------------
@@ -283,32 +286,36 @@ void LightNode::renderSolid(RenderableCollector& collector, const VolumeTest& vo
 
     // Re-use the same method as in wireframe rendering for the moment
     const bool lightIsSelected = isSelected();
-    renderLightVolume(
-        collector, volume, localToWorld(), lightIsSelected
-    );
+    renderLightVolume(collector, localToWorld(), lightIsSelected);
 
     renderInactiveComponents(collector, volume, lightIsSelected);
 }
 
 void LightNode::renderWireframe(RenderableCollector& collector, const VolumeTest& volume) const
 {
-	EntityNode::renderWireframe(collector, volume);
+    EntityNode::renderWireframe(collector, volume);
 
-	const bool lightIsSelected = isSelected();
-	renderLightVolume(
-		collector, volume, localToWorld(), lightIsSelected
-	);
+    const bool lightIsSelected = isSelected();
+    renderLightVolume(collector, localToWorld(), lightIsSelected);
 
-	renderInactiveComponents(collector, volume, lightIsSelected);
+    renderInactiveComponents(collector, volume, lightIsSelected);
 }
 
 void LightNode::renderLightVolume(RenderableCollector& collector,
-                                  const VolumeTest& volume,
                                   const Matrix4& localToWorld,
                                   bool selected) const
 {
+    // Obtain the appropriate Shader for the light volume colour
+    static registry::CachedKey<bool> _overrideColKey(
+        colours::RKEY_OVERRIDE_LIGHTCOL
+    );
+    Shader* colourShader = _overrideColKey.get() ? EntityNode::_wireShader.get()
+                                                 : _colourKey.getWireShader();
+    if (!colourShader)
+        return;
+
     // Main render, submit the diamond that represents the light entity
-    collector.addRenderable(*getColourShader(), *this, localToWorld);
+    collector.addRenderable(*colourShader, *this, localToWorld);
 
     // Render bounding box if selected or the showAllLighRadii flag is set
     if (selected || EntitySettings::InstancePtr()->getShowAllLightRadii())
@@ -318,12 +325,12 @@ void LightNode::renderLightVolume(RenderableCollector& collector,
             // greebo: This is not much of an performance impact as the
             // projection gets only recalculated when it has actually changed.
             _light.updateProjection();
-            collector.addRenderable(*getColourShader(), _renderableFrustum, localToWorld);
+            collector.addRenderable(*colourShader, _renderableFrustum, localToWorld);
         }
         else
         {
             updateRenderableRadius();
-            collector.addRenderable(*getColourShader(), _renderableRadius, localToWorld);
+            collector.addRenderable(*colourShader, _renderableRadius, localToWorld);
         }
     }
 }

diff --git a/radiantcore/entity/light/LightNode.h b/radiantcore/entity/light/LightNode.h
@@ -144,7 +144,6 @@ class LightNode :
 
     // Render the light volume including bounds and origin
     void renderLightVolume(RenderableCollector& collector,
-                           const VolumeTest& volume,
                            const Matrix4& localToWorld, bool selected) const;
 
     // Update the bounds of the renderable radius box