Ticket #3915: visualrange_v0.2.patch

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

@@ -867 +867 @@
                 color = cmpPlayer.GetColor();
             playerColors[owner] = color;
         }
+        let cmpIdentity = Engine.QueryInterface(ent, IID_Identity);
+        let showRange = cmpIdentity.HasClass("Defensive") && owner == player;
 
-        cmpSelectable.SetSelectionHighlight({ "r": color.r, "g": color.g, "b": color.b, "a": cmd.alpha }, cmd.selected);
+        cmpSelectable.SetSelectionHighlight({ "r": color.r, "g": color.g, "b": color.b, "a": cmd.alpha }, cmd.selected, showRange);
     }
 };
 

source/simulation2/components/CCmpSelectable.cpp

@@ -38 +38 @@
 #include "simulation2/components/ICmpOwnership.h"
 #include "simulation2/components/ICmpPlayer.h"
 #include "simulation2/components/ICmpPlayerManager.h"
+#include "simulation2/components/ICmpVision.h"
 #include "simulation2/components/ICmpWaterManager.h"
 #include "simulation2/helpers/Render.h"
 #include "simulation2/system/Component.h"
@@ -64 +65 @@
 
     CCmpSelectable()
         : m_DebugBoundingBoxOverlay(NULL), m_DebugSelectionBoxOverlay(NULL), 
-          m_BuildingOverlay(NULL), m_UnitOverlay(NULL),
+          m_BuildingOverlay(NULL), m_RangeOverlay(NULL), m_UnitOverlay(NULL),
           m_FadeBaselineAlpha(0.f), m_FadeDeltaAlpha(0.f), m_FadeProgress(0.f),
-          m_Selected(false), m_Cached(false), m_Visible(false)
+          m_Selected(false), m_Cached(false), m_Visible(false), m_ShowRange(false)
     {
         m_Color = CColor(0, 0, 0, m_FadeBaselineAlpha);
     }
@@ -76 +77 @@
         delete m_DebugBoundingBoxOverlay;
         delete m_DebugSelectionBoxOverlay;
         delete m_BuildingOverlay;
+        delete m_RangeOverlay;
         delete m_UnitOverlay;
     }
 
@@ -167 +169 @@
 
     virtual void HandleMessage(const CMessage& msg, bool UNUSED(global));
 
-    virtual void SetSelectionHighlight(const CColor& color, bool selected)
+    virtual void SetSelectionHighlight(const CColor& color, bool selected, bool showRange = false)
     {
         m_Selected = selected;
         m_Color.r = color.r;
         m_Color.g = color.g;
         m_Color.b = color.b;
+        m_ShowRange = showRange;
 
         // Always-visible overlays will be desaturated if their parent unit is deselected.
         if (m_AlwaysVisible && !selected)
@@ -247 +250 @@
 private:
     SOverlayDescriptor m_OverlayDescriptor;
     SOverlayTexturedLine* m_BuildingOverlay;
+    SOverlayTexturedLine* m_RangeOverlay;
     SOverlayQuad* m_UnitOverlay;
 
     SOverlayLine* m_DebugBoundingBoxOverlay;
@@ -275 +279 @@
     float m_FadeDeltaAlpha;
     /// Linear time progress of the fade, between 0 and m_FadeDuration.
     float m_FadeProgress;
+    /// Whether visual range will be shown.
+    bool m_ShowRange;
 
     /// Total duration of a single fade, in seconds. Assumed constant for now; feel free to change this into
     /// a member variable if you need to adjust it per component.
@@ -340 +346 @@
         // 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->GetColor();
-        SetSelectionHighlight(CColor(color.r, color.g, color.b, m_FadeBaselineAlpha + m_FadeDeltaAlpha), m_Selected);
+        SetSelectionHighlight(CColor(color.r, color.g, color.b, m_FadeBaselineAlpha + m_FadeDeltaAlpha), m_Selected, m_ShowRange);
 
         InvalidateStaticOverlay();
         break;
@@ -400 +406 @@
 void CCmpSelectable::InvalidateStaticOverlay()
 {
     SAFE_DELETE(m_BuildingOverlay);
+    SAFE_DELETE(m_RangeOverlay);
+
 }
 
 void CCmpSelectable::UpdateStaticOverlay()
@@ -449 +457 @@
     m_BuildingOverlay->m_TextureBase = g_Renderer.GetTextureManager().CreateTexture(texturePropsBase);
     m_BuildingOverlay->m_TextureMask = g_Renderer.GetTextureManager().CreateTexture(texturePropsMask);
 
+    m_RangeOverlay = new SOverlayTexturedLine;
+    m_RangeOverlay->m_AlwaysVisible = false;
+    m_RangeOverlay->m_Closed = true;
+    m_RangeOverlay->m_SimContext = &GetSimContext();
+    m_RangeOverlay->m_Thickness = m_OverlayDescriptor.m_LineThickness;
+    m_RangeOverlay->m_TextureBase = g_Renderer.GetTextureManager().CreateTexture(texturePropsBase);
+    m_RangeOverlay->m_TextureMask = g_Renderer.GetTextureManager().CreateTexture(texturePropsMask);
+
     CVector2D origin(position.X.ToFloat(), position.Y.ToFloat());
 
+    float rangeRadius;
+
+    if (m_ShowRange)
+    {
+        CmpPtr<ICmpVision> cmpVision(GetSimContext(), GetEntityId());
+        if (!cmpVision)
+            return;
+        rangeRadius = cmpVision->GetRange().ToFloat();
+
+        float stepAngle;
+        unsigned numSteps;
+        SimRender::AngularStepFromChordLen(TERRAIN_TILE_SIZE / 3.f, rangeRadius, stepAngle, numSteps);
+
+        for (unsigned i = 0; i < numSteps; i++)
+        {
+            float angle = i * stepAngle;
+            float px = origin.X + rangeRadius * sinf(angle);
+            float pz = origin.Y + rangeRadius * cosf(angle);
+
+            m_RangeOverlay->PushCoords(px, pz);
+        }
+    }
+
     switch (fpShape)
     {
     case ICmpFootprint::SQUARE:
@@ -617 +656 @@
             }
             color.a = m_FadeBaselineAlpha + m_FadeDeltaAlpha;
 
-            SetSelectionHighlight(color, m_Selected);
+            SetSelectionHighlight(color, m_Selected, m_ShowRange);
             m_Cached = true;
         }
 
@@ -628 +667 @@
                     UpdateStaticOverlay();
                     m_BuildingOverlay->m_Color = m_Color; // done separately so alpha changes don't require a full update call
                     collector.Submit(m_BuildingOverlay);
+                    m_RangeOverlay->m_Color = m_Color;
+                    collector.Submit(m_RangeOverlay);
                 }
                 break;
             case DYNAMIC_QUAD:

source/simulation2/components/ICmpSelectable.cpp

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

source/simulation2/components/ICmpSelectable.h

@@ -57 +57 @@
      * The highlight is typically a circle/square overlay around the unit.
      * @param color color and alpha of the selection highlight. Set color.a = 0 to hide the highlight.
      * @param selected whether the entity is selected; affects desaturation for always visible highlights.
+     * @param showRange whether visual range will be shown.
      */
-    virtual void SetSelectionHighlight(const CColor& color, bool selected) = 0;
+    virtual void SetSelectionHighlight(const CColor& color, bool selected, bool showRange = false) = 0;
 
     /**
      * Enables or disables rendering of an entity's selectable.