Ticket #1365: hero-overlay-alpha-desaturate-3.patch

source/tools/atlas/GameInterface/Handlers/ObjectHandlers.cpp

@@ -148 +148 @@
             }
         }
 
-        cmpSelectable->SetSelectionHighlight(colour);
+        cmpSelectable->SetSelectionHighlight(colour, true);
     }
 }
 

source/simulation2/components/ICmpSelectable.h

@@ -56 +56 @@
      * Set the color of the selection highlight (typically a circle/square
      * around the unit). Set a = 0 to disable the highlight.
      */
-    virtual void SetSelectionHighlight(CColor color) = 0;
+    virtual void SetSelectionHighlight(CColor color, bool selected) = 0;
 
     /**
      * Set the alpha of the selection highlight. Set to 0 to disable the highlight.

source/simulation2/components/ICmpSelectable.cpp

@@ -24 +24 @@
 #include "ps/Overlay.h"
 
 BEGIN_INTERFACE_WRAPPER(Selectable)
-DEFINE_INTERFACE_METHOD_1("SetSelectionHighlight", void, ICmpSelectable, SetSelectionHighlight, CColor)
+DEFINE_INTERFACE_METHOD_2("SetSelectionHighlight", void, ICmpSelectable, SetSelectionHighlight, CColor, bool)
 END_INTERFACE_WRAPPER(Selectable)
 
 bool ICmpSelectable::ms_EnableDebugOverlays = false;

source/simulation2/components/CCmpSelectable.cpp

@@ -59 +59 @@
     CCmpSelectable()
         : m_DebugBoundingBoxOverlay(NULL), m_DebugSelectionBoxOverlay(NULL), 
           m_BuildingOverlay(NULL), m_UnitOverlay(NULL),
-          m_FadeBaselineAlpha(0.f), m_FadeDeltaAlpha(0.f), m_FadeProgress(0.f)
+          m_FadeBaselineAlpha(0.f), m_FadeDeltaAlpha(0.f), m_FadeProgress(0.f),
+          m_Selected(false), m_Cached(false)
     {
         m_Color = CColor(0, 0, 0, m_FadeBaselineAlpha);
     }
@@ -83 +84 @@
                 "</element>"
             "</optional>"
             "<element name='Overlay' a:help='Specifies the type of overlay to be displayed when this entity is selected'>"
+                "<optional>"
+                    "<element name='AlwaysVisible' a:help='If this element is present, the minimum alpha of the overlay will be 50%'>"
+                        "<empty/>"
+                    "</element>"
+                "</optional>"
                 "<choice>"
                     "<element name='Texture' a:help='Displays a texture underneath the entity.'>"
                         "<element name='MainTexture' a:help='Texture to display underneath the entity. Filepath relative to art/textures/selection/.'><text/></element>"
@@ -101 +107 @@
     {
         m_EditorOnly = paramNode.GetChild("EditorOnly").IsOk();
 
+        // Certain special units always have their selection overlay shown.
+        m_AlphaMin = paramNode.GetChild("Overlay").GetChild("AlwaysVisible").IsOk() ? .5 : 0.;
+        if (m_AlphaMin > 0.)
+            m_Color.a = m_AlphaMin;
+
         const CParamNode& textureNode = paramNode.GetChild("Overlay").GetChild("Texture");
         const CParamNode& outlineNode = paramNode.GetChild("Overlay").GetChild("Outline");
 
@@ -141 +152 @@
 
     virtual void HandleMessage(const CMessage& msg, bool UNUSED(global));
 
-    virtual void SetSelectionHighlight(CColor color)
+    virtual void SetSelectionHighlight(CColor color, bool selected)
     {
+        m_Selected = selected;
         m_Color.r = color.r;
         m_Color.g = color.g;
         m_Color.b = color.b;
+
+        // Always-visible overlays will be desaturated if their parent unit is deselected.
+        if (m_AlphaMin > 0. && !selected)
+        {
+            float max;
+
+            // Reduce saturation by one-third, the quick-and-dirty way.
+            if (m_Color.r > m_Color.b)
+               max = (m_Color.r > m_Color.g) ? m_Color.r : m_Color.g;
+            else
+               max = (m_Color.b > m_Color.g) ? m_Color.b : m_Color.g;
+
+            m_Color.r += (max - m_Color.r) / 3.;
+            m_Color.g += (max - m_Color.g) / 3.;
+            m_Color.b += (max - m_Color.b) / 3.;
+        }
+
         SetSelectionHighlightAlpha(color.a);
     }
 
     virtual void SetSelectionHighlightAlpha(float alpha)
     {
+        alpha = std::max(m_AlphaMin, alpha);
+
         // set up fading from the current value (as the baseline) to the target value
         m_FadeBaselineAlpha = m_Color.a;
         m_FadeDeltaAlpha = alpha - m_FadeBaselineAlpha;
@@ -191 +222 @@
     /// Is this entity selectable only in the editor?
     bool m_EditorOnly;
     
+
+    /// Whether the parent entity is selected (caches GUI's selection state).
+    bool m_Selected;
     /// Current selection overlay color. Alpha component is subject to fading.
     CColor m_Color;
+    /// Whether the selectable's player colour has been cached for rendering.
+    bool m_Cached;
+    /// Minimum value for current selection overlay alpha.
+    float m_AlphaMin;
     /// Baseline alpha value to start fading from. Constant during a single fade.
     float m_FadeBaselineAlpha;
     /// Delta between target and baseline alpha. Constant during a single fade. Can be positive or negative.
@@ -260 +298 @@
             // Update the highlight color, while keeping the current alpha target value intact
             // (i.e. baseline + delta), so that any ongoing fades simply continue with the new color.
             CColor color = cmpPlayer->GetColour();
-            SetSelectionHighlight(CColor(color.r, color.g, color.b, m_FadeBaselineAlpha + m_FadeDeltaAlpha));
+            SetSelectionHighlight(CColor(color.r, color.g, color.b, m_FadeBaselineAlpha + m_FadeDeltaAlpha), m_Selected);
         }
         // fall-through
     case MT_PositionChanged:
@@ -473 +511 @@
     // don't render selection overlay if it's not gonna be visible
     if (m_Color.a > 0)
     {
+        if (!m_Cached)
+        {
+            // Try to initialize m_Color to the owning player's colour.
+            CmpPtr<ICmpPlayerManager> cmpPlayerManager(GetSimContext(), SYSTEM_ENTITY);
+            if (!cmpPlayerManager)
+                return;
+    
+            CmpPtr<ICmpOwnership> cmpOwnership(GetSimContext(), GetEntityId());
+            if (!cmpOwnership)
+                return;
+    
+            player_id_t owner = cmpOwnership->GetOwner();
+            if (owner == INVALID_PLAYER)
+                return;
+    
+            CmpPtr<ICmpPlayer> cmpPlayer(GetSimContext(), cmpPlayerManager->GetPlayerByID(owner));
+            if (!cmpPlayer)
+                return;
+
+            CColor color = cmpPlayer->GetColour();
+            color.a = m_FadeBaselineAlpha + m_FadeDeltaAlpha;
+
+            SetSelectionHighlight(color, m_Selected);
+            m_Cached = true;
+        }
+
         switch (m_OverlayDescriptor.m_Type)
         {
             case STATIC_OUTLINE:

binaries/data/mods/public/gui/session/selection.js

@@ -1 +1 @@
 const MAX_SELECTION_SIZE = 200; // Limits selection size
 
-function _setHighlight(ents, alpha)
+function _setHighlight(ents, alpha, selected)
 {
     if (ents.length)
-        Engine.GuiInterfaceCall("SetSelectionHighlight", { "entities":ents, "alpha":alpha });
+        Engine.GuiInterfaceCall("SetSelectionHighlight", { "entities":ents, "alpha":alpha, "selected":selected });
 }
 
 function _setStatusBars(ents, enabled)
@@ -214 +214 @@
         if (entState.visibility == "hidden")
         {
             // Disable any highlighting of the disappeared unit
-            _setHighlight([ent], 0);
+            _setHighlight([ent], 0, false);
             _setStatusBars([ent], false);
             _setMotionOverlay([ent], false);
 
@@ -280 +280 @@
         }
     }
 
-    _setHighlight(added, 1);
+    _setHighlight(added, 1, true);
     _setStatusBars(added, true);
     _setMotionOverlay(added, this.motionDebugOverlay);
     if (added.length)
@@ -304 +304 @@
         }
     }
 
-    _setHighlight(removed, 0);
+    _setHighlight(removed, 0, false);
     _setStatusBars(removed, false);
     _setMotionOverlay(removed, false);
 
@@ -313 +313 @@
 
 EntitySelection.prototype.reset = function()
 {
-    _setHighlight(this.toList(), 0);
+    _setHighlight(this.toList(), 0, false);
     _setStatusBars(this.toList(), false);
     _setMotionOverlay(this.toList(), false);
     this.selected = {};
@@ -349 +349 @@
         if (!this.highlighted[ent] && !this.selected[ent])
             added.push(+ent);
 
-    _setHighlight(removed, 0);
+    _setHighlight(removed, 0, false);
     _setStatusBars(removed, false);
 
-    _setHighlight(added, 0.5);
+    _setHighlight(added, 0.5, true);
     _setStatusBars(added, true);
     
     // Store the new highlight list

binaries/data/mods/public/simulation/components/GuiInterface.js

@@ -591 +591 @@
     return false;
 };
 
-GuiInterface.prototype.SetSelectionHighlight = function(player, cmd)
+GuiInterface.prototype.SetSelectionHighlight = function(player, cmd, selected)
 {
     var cmpPlayerMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
     var playerColours = {}; // cache of owner -> colour map
@@ -618 +618 @@
             playerColours[owner] = colour;
         }
 
-        cmpSelectable.SetSelectionHighlight({"r":colour.r, "g":colour.g, "b":colour.b, "a":cmd.alpha});
+        cmpSelectable.SetSelectionHighlight({"r":colour.r, "g":colour.g, "b":colour.b, "a":cmd.alpha}, cmd.selected);
     }
 };
 

binaries/data/mods/public/simulation/templates/template_unit_hero_cavalry_archer.xml

@@ -62 +62 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero_infantry.xml

@@ -51 +51 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero.xml

@@ -49 +49 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero_infantry_archer.xml

@@ -54 +54 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero_infantry_javelinist.xml

@@ -58 +58 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero_cavalry_javelinist.xml

@@ -52 +52 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>

binaries/data/mods/public/simulation/templates/template_unit_hero_cavalry.xml

@@ -53 +53 @@
   </Minimap>
   <Selectable>
     <Overlay>
+      <AlwaysVisible/>
       <Texture>
         <MainTexture>star/256x256.png</MainTexture>
         <MainTextureMask>star/256x256_mask.png</MainTextureMask>