#5430: Use the override colour changed signal to update the eclasses …

…during runtime

include/ieclasscolours.h

@@ -40,7 +40,8 @@ class IColourManager :
     virtual void clearOverrideColours() = 0;
 
     // Signal invoked when an override of a specific eclass is added, changed or removed
-    virtual sigc::signal<void, const std::string&>& sig_overrideColourChanged() = 0;
+    // function signature: void(const std::string& eclass, bool hasBeenRemoved)
+    virtual sigc::signal<void, const std::string&, bool>& sig_overrideColourChanged() = 0;
 };
 
 }

radiantcore/eclass/Doom3EntityClass.cpp

@@ -299,6 +299,22 @@ void Doom3EntityClass::setColour(const Vector3& colour)
     _changedSignal.emit();
 }
 
+void Doom3EntityClass::resetColour()
+{
+    // (Re)set the colour
+    const EntityClassAttribute& colourAttr = getAttribute("editor_color");
+
+    if (!colourAttr.getValue().empty())
+    {
+        setColour(string::convert<Vector3>(colourAttr.getValue()));
+    }
+    else
+    {
+        // If no colour is set, assign the default entity colour to this class
+        setColour(DefaultEntityColour);
+    }
+}
+
 const Vector3& Doom3EntityClass::getColour() const {
     return _colour;
 }
@@ -436,18 +452,7 @@ void Doom3EntityClass::resolveInheritance(EntityClasses& classmap)
         _colourTransparent = true;
     }
 
-    // (Re)set the colour
-    const EntityClassAttribute& colourAttr = getAttribute("editor_color");
-
-    if (!colourAttr.getValue().empty())
-    {
-        setColour(string::convert<Vector3>(colourAttr.getValue()));
-    }
-    else
-    {
-        // If no colour is set, assign the default entity colour to this class
-        setColour(DefaultEntityColour);
-    }
+    resetColour();
 }
 
 bool Doom3EntityClass::isOfType(const std::string& className)

radiantcore/eclass/Doom3EntityClass.h

@@ -165,6 +165,8 @@ class Doom3EntityClass
     const Vector3& getColour() const override;
     /// Set the display colour
     void setColour(const Vector3& colour) override;
+    // Resets the colour to the value defined in the attributes
+    void resetColour();
     const std::string& getWireShader() const override;
     const std::string& getFillShader() const override;
     EntityClassAttribute& getAttribute(const std::string& name) override;

radiantcore/eclass/EClassColourManager.cpp

@@ -9,7 +9,7 @@ namespace eclass
 void EClassColourManager::addOverrideColour(const std::string& eclass, const Vector3& colour)
 {
     _overrides[eclass] = colour;
-    _overrideChangedSignal.emit(eclass);
+    _overrideChangedSignal.emit(eclass, false); // false ==> colour added
 }
 
 void EClassColourManager::applyColours(const IEntityClassPtr& eclass)
@@ -38,7 +38,7 @@ void EClassColourManager::foreachOverrideColour(
 void EClassColourManager::removeOverrideColour(const std::string& eclass)
 {
     _overrides.erase(eclass);
-    _overrideChangedSignal.emit(eclass);
+    _overrideChangedSignal.emit(eclass, true); // true ==> colour removed
 }
 
 void EClassColourManager::clearOverrideColours()
@@ -53,11 +53,11 @@ void EClassColourManager::clearOverrideColours()
 
         // Fire signal, this might call applyColours which will
         // find the colour has have been removed
-        _overrideChangedSignal.emit(eclass);
+        _overrideChangedSignal.emit(eclass, true); // true ==> colour removed
     }
 }
 
-sigc::signal<void, const std::string&>& EClassColourManager::sig_overrideColourChanged()
+sigc::signal<void, const std::string&, bool>& EClassColourManager::sig_overrideColourChanged()
 {
     return _overrideChangedSignal;
 }

radiantcore/eclass/EClassColourManager.h

@@ -11,7 +11,7 @@ class EClassColourManager :
 {
 private:
     std::map<std::string, Vector3> _overrides;
-    sigc::signal<void, const std::string&> _overrideChangedSignal;
+    sigc::signal<void, const std::string&, bool> _overrideChangedSignal;
 
 public:
     // IColourManager implementation
@@ -21,7 +21,7 @@ class EClassColourManager :
     void foreachOverrideColour(const std::function<void(const std::string&, const Vector3&)>& functor) override;
     void removeOverrideColour(const std::string& eclass) override;
     void clearOverrideColours() override;
-    sigc::signal<void, const std::string&>& sig_overrideColourChanged() override;
+    sigc::signal<void, const std::string&, bool>& sig_overrideColourChanged() override;
 
     // RegisterableModule implementation
 

radiantcore/eclass/EClassManager.cpp

@@ -315,12 +315,17 @@ void EClassManager::initialiseModule(const IApplicationContext& ctx)
     }
 
 	GlobalCommandSystem().addCommand("ReloadDefs", std::bind(&EClassManager::reloadDefsCmd, this, std::placeholders::_1));
+
+    _eclassColoursChanged = GlobalEclassColourManager().sig_overrideColourChanged().connect(
+        sigc::mem_fun(this, &EClassManager::onEclassOverrideColourChanged));
 }
 
 void EClassManager::shutdownModule()
 {
 	rMessage() << "EntityClassDoom3::shutdownModule called." << std::endl;
 
+    _eclassColoursChanged.disconnect();
+
 	GlobalFileSystem().removeObserver(*this);
 
 	// Unrealise ourselves and wait for threads to finish
@@ -334,6 +339,29 @@ void EClassManager::shutdownModule()
 	_models.clear();
 }
 
+void EClassManager::onEclassOverrideColourChanged(const std::string& eclass, bool overrideRemoved)
+{
+    // An override colour in the IColourManager instance has changed
+    // Do we have an affected eclass with that name?
+    auto foundEclass = _entityClasses.find(eclass);
+
+    if (foundEclass == _entityClasses.end())
+    {
+        return;
+    }
+
+    // If the override was removed, we just reset the colour
+    // We perform this switch to avoid firing the eclass changed signal twice
+    if (overrideRemoved)
+    {
+        foundEclass->second->resetColour();
+    }
+    else
+    {
+        GlobalEclassColourManager().applyColours(foundEclass->second);
+    }
+}
+
 // This takes care of relading the entityDefs and refreshing the scenegraph
 void EClassManager::reloadDefsCmd(const cmd::ArgumentList& args)
 {

radiantcore/eclass/EClassManager.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <sigc++/connection.h>
 #include "ieclass.h"
 #include "icommandsystem.h"
 #include "ifilesystem.h"
@@ -51,6 +52,8 @@ class EClassManager :
     sigc::signal<void> _defsLoadedSignal;
     sigc::signal<void> _defsReloadedSignal;
 
+    sigc::connection _eclassColoursChanged;
+
 public:
     // Constructor
 	EClassManager();
@@ -111,6 +114,8 @@ class EClassManager :
 	void resolveInheritance();
 
 	void reloadDefsCmd(const cmd::ArgumentList& args);
+
+    void onEclassOverrideColourChanged(const std::string& eclass, bool overrideRemoved);
 };
 typedef std::shared_ptr<EClassManager> EClassManagerPtr;