Ticket #3685: rebased_clearance.patch

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

@@ -133 +133 @@
     if (!cmpObstruction)
         return result; // Fail
 
-
-    if (this.template.Category == "Wall")
-    {
-        // for walls, only test the center point
-        var ret = cmpObstruction.CheckFoundation(passClassName, true);
-    }
-    else
-    {
-        var ret = cmpObstruction.CheckFoundation(passClassName, false);
-    }
+    var ret = cmpObstruction.CheckFoundation(passClassName);
 
     if (ret != "success")
     {

binaries/data/mods/public/simulation/templates/other/bridge_hele.xml

@@ -20 +20 @@
   </Identity>
   <Minimap disable=""/>
   <Obstruction>
+    <Static disable=""/>
     <Obstructions>
       <Edge width="59" depth="4" x="0" z="5"/> 
     </Obstructions>

binaries/data/mods/public/simulation/templates/other/bridge_wooden.xml

@@ -20 +20 @@
   </Identity>
   <Minimap disable=""/>
   <Obstruction>
+    <Static disable=""/>
     <Obstructions>
       <Edge width="59" depth="4" x="0" z="5"/> 
     </Obstructions>

binaries/data/mods/public/simulation/templates/other/palisades_rocks_tower.xml

@@ -30 +30 @@
     <RequiredTechnology>phase_village</RequiredTechnology>
   </Identity>
   <Obstruction>
-    <Static width="4.0" depth="4.0"/>
+    <Static width="4.0" depth="4.0" clearance="-1"/>
     <ControlPersist/>
   </Obstruction>
   <StatusBars>

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

@@ -66 +66 @@
     <Type>structure</Type>
   </Minimap>
   <Obstruction>
+    <Static width="2" depth="2" clearance="4"/>
     <Active>true</Active>
     <BlockMovement>true</BlockMovement>
     <BlockPathfinding>true</BlockPathfinding>

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

@@ -31 +31 @@
     <stone>15</stone>
   </Loot>
   <Obstruction>
-    <Static width="6.0" depth="6.0"/>
+    <Static width="6.0" depth="6.0" clearance="0"/>
   </Obstruction>
   <ProductionQueue disable=""/>
   <RallyPoint disable=""/>

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

@@ -58 +58 @@
     <stone>15</stone>
   </Loot>
   <Obstruction>
-    <Static width="6.0" depth="6.0"/>
+    <Static width="6.0" depth="6.0" clearance="-1"/>
     <ControlPersist/>
   </Obstruction>
   <ProductionQueue>

source/simulation2/components/CCmpObstruction.cpp

@@ -122 +122 @@
                             "<param name='minInclusive'>1.5</param>"
                         "</data>"
                     "</attribute>"
+                    "<optional>"
+                        "<attribute name='clearance' a:help='Extra clearance to be applied when placing the entity, ensures there is passable space around it (can be negative to allow for overlap, if the overlap is small enough to not cause problems).'>"
+                            "<data type='decimal'/>"
+                        "</attribute>"
+                    "</optional>"
                 "</element>"
                 "<element name='Unit'>"
                     "<empty/>"
@@ -216 +221 @@
             m_Type = STATIC;
             m_Size0 = paramNode.GetChild("Static").GetChild("@width").ToFixed();
             m_Size1 = paramNode.GetChild("Static").GetChild("@depth").ToFixed();
+            m_Clearance = paramNode.GetChild("Static").GetChild("@clearance").ToFixed();
             ENSURE(m_Size0 > minObstruction);
             ENSURE(m_Size1 > minObstruction);
         }
@@ -244 +250 @@
             }
             m_Size0 = fixed::FromInt(2).Multiply(MAX(max.X, -min.X));
             m_Size1 = fixed::FromInt(2).Multiply(MAX(max.Y, -min.Y));
+            // TODO perhaps support clearance per obstruction
+            m_Clearance = entity_pos_t::Zero();
         }
 
         m_Active = paramNode.GetChild("Active").ToBool();
@@ -525 +533 @@
     
     virtual EFoundationCheck CheckFoundation(std::string className)
     {
-        return  CheckFoundation(className, false);
-    }
-
-    virtual EFoundationCheck CheckFoundation(std::string className, bool onlyCenterPoint)
-    {
         CmpPtr<ICmpPosition> cmpPosition(GetEntityHandle());
         if (!cmpPosition)
             return FOUNDATION_CHECK_FAIL_ERROR; // error
@@ -560 +563 @@
             ICmpObstructionManager::FLAG_BLOCK_FOUNDATION);
 
         if (m_Type == UNIT)
-            return cmpPathfinder->CheckUnitPlacement(filter, pos.X, pos.Y, m_Clearance, passClass, onlyCenterPoint);
+            return cmpPathfinder->CheckUnitPlacement(filter, pos.X, pos.Y, m_Clearance, passClass);
         else
-            return cmpPathfinder->CheckBuildingPlacement(filter, pos.X, pos.Y, cmpPosition->GetRotation().Y, m_Size0, m_Size1, GetEntityId(), passClass, onlyCenterPoint);
+            return cmpPathfinder->CheckBuildingPlacement(filter, pos.X, pos.Y, cmpPosition->GetRotation().Y, m_Size0, m_Size1, GetEntityId(), passClass, m_Clearance * 2);
     }
 
     virtual bool CheckDuplicateFoundation()

source/simulation2/components/CCmpPathfinder.cpp

@@ -810 +810 @@
 }
 
 ICmpObstruction::EFoundationCheck CCmpPathfinder::CheckUnitPlacement(const IObstructionTestFilter& filter,
-    entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass, bool UNUSED(onlyCenterPoint))
+    entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass)
 {
     // Check unit obstruction
     CmpPtr<ICmpObstructionManager> cmpObstructionManager(GetSystemEntity());
@@ -838 +838 @@
     entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w,
     entity_pos_t h, entity_id_t id, pass_class_t passClass)
 {
-    return CCmpPathfinder::CheckBuildingPlacement(filter, x, z, a, w, h, id, passClass, false);
+    return CCmpPathfinder::CheckBuildingPlacement(filter, x, z, a, w, h, id, passClass, entity_pos_t::Zero());
 }
 
 
 ICmpObstruction::EFoundationCheck CCmpPathfinder::CheckBuildingPlacement(const IObstructionTestFilter& filter,
     entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w,
-    entity_pos_t h, entity_id_t id, pass_class_t passClass, bool UNUSED(onlyCenterPoint))
+    entity_pos_t h, entity_id_t id, pass_class_t passClass, entity_pos_t clearance)
 {
     // Check unit obstruction
     CmpPtr<ICmpObstructionManager> cmpObstructionManager(GetSystemEntity());
     if (!cmpObstructionManager)
         return ICmpObstruction::FOUNDATION_CHECK_FAIL_ERROR;
 
-    if (cmpObstructionManager->TestStaticShape(filter, x, z, a, w, h, NULL))
+    if (cmpObstructionManager->TestStaticShape(filter, x, z, a, w + clearance, h + clearance, NULL))
         return ICmpObstruction::FOUNDATION_CHECK_FAIL_OBSTRUCTS_FOUNDATION;
 
     // Test against terrain:

source/simulation2/components/CCmpPathfinder_Common.h

@@ -273 +273 @@
 
     virtual bool CheckMovement(const IObstructionTestFilter& filter, entity_pos_t x0, entity_pos_t z0, entity_pos_t x1, entity_pos_t z1, entity_pos_t r, pass_class_t passClass);
 
-    virtual ICmpObstruction::EFoundationCheck CheckUnitPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass, bool onlyCenterPoint);
+    virtual ICmpObstruction::EFoundationCheck CheckUnitPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass);
 
     virtual ICmpObstruction::EFoundationCheck CheckBuildingPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h, entity_id_t id, pass_class_t passClass);
 
-    virtual ICmpObstruction::EFoundationCheck CheckBuildingPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h, entity_id_t id, pass_class_t passClass, bool onlyCenterPoint);
+    virtual ICmpObstruction::EFoundationCheck CheckBuildingPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h, entity_id_t id, pass_class_t passClass, entity_pos_t clearance);
 
     virtual void FinishAsyncRequests();
 

source/simulation2/components/ICmpObstruction.cpp

@@ -23 +23 @@
 
 #include "simulation2/system/SimContext.h"
 
-std::string ICmpObstruction::CheckFoundation_wrapper(const std::string& className, bool onlyCenterPoint)
+std::string ICmpObstruction::CheckFoundation_wrapper(const std::string& className)
 {
-    EFoundationCheck check = CheckFoundation(className, onlyCenterPoint);
+    EFoundationCheck check = CheckFoundation(className);
 
     switch (check)
     {
@@ -47 +47 @@
 
 BEGIN_INTERFACE_WRAPPER(Obstruction)
 DEFINE_INTERFACE_METHOD_0("GetUnitRadius", entity_pos_t, ICmpObstruction, GetUnitRadius)
-DEFINE_INTERFACE_METHOD_2("CheckFoundation", std::string, ICmpObstruction, CheckFoundation_wrapper, std::string, bool)
+DEFINE_INTERFACE_METHOD_1("CheckFoundation", std::string, ICmpObstruction, CheckFoundation_wrapper, std::string)
 DEFINE_INTERFACE_METHOD_0("CheckDuplicateFoundation", bool, ICmpObstruction, CheckDuplicateFoundation)
 DEFINE_INTERFACE_METHOD_0("GetUnitCollisions", std::vector<entity_id_t>, ICmpObstruction, GetUnitCollisions)
 DEFINE_INTERFACE_METHOD_1("SetActive", void, ICmpObstruction, SetActive, bool)

source/simulation2/components/ICmpObstruction.h

@@ -68 +68 @@
      *  value describing the type of failure.
      */
     virtual EFoundationCheck CheckFoundation(std::string className) = 0;
-    virtual EFoundationCheck CheckFoundation(std::string className, bool onlyCenterPoint) = 0;
 
     /**
      * CheckFoundation wrapper for script calls, to return friendly strings instead of an EFoundationCheck.
      * @return "success" if check passes, else a string describing the type of failure.
      */
-    virtual std::string CheckFoundation_wrapper(const std::string& className, bool onlyCenterPoint);
+    virtual std::string CheckFoundation_wrapper(const std::string& className);
 
     /**
      * Test whether this entity is colliding with any obstructions that share its

source/simulation2/components/ICmpPathfinder.h

@@ -134 +134 @@
     /**
      * Check whether a unit placed here is valid and doesn't hit any obstructions
      * or impassable terrain.
-     * When onlyCenterPoint = true, only check the center tile of the unit
      * @return ICmpObstruction::FOUNDATION_CHECK_SUCCESS if the placement is okay, else
      *  a value describing the type of failure.
      */
-    virtual ICmpObstruction::EFoundationCheck CheckUnitPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass, bool onlyCenterPoint = false) = 0;
+    virtual ICmpObstruction::EFoundationCheck CheckUnitPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t r, pass_class_t passClass) = 0;
 
     /**
      * Check whether a building placed here is valid and doesn't hit any obstructions
@@ -151 +150 @@
     /**
      * Check whether a building placed here is valid and doesn't hit any obstructions
      * or impassable terrain.
-     * when onlyCenterPoint = true, only check the center tile of the building
      * @return ICmpObstruction::FOUNDATION_CHECK_SUCCESS if the placement is okay, else
      *  a value describing the type of failure.
      */
-    virtual ICmpObstruction::EFoundationCheck CheckBuildingPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h, entity_id_t id, pass_class_t passClass, bool onlyCenterPoint) = 0;
+    virtual ICmpObstruction::EFoundationCheck CheckBuildingPlacement(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h, entity_id_t id, pass_class_t passClass, entity_pos_t clearance) = 0;
 
 
     /**