Nav updates

Moose Development/Moose/Navigation/Towns.lua

@@ -1,9 +1,10 @@
---- **NAVIGATION** - Beacons of the map/theatre.
+--- **NAVIGATION** - Towns of the map/theatre.
 --
 -- **Main Features:**
 --
 --    * Find towns of map
 --    * Road and rail connections
+--    * Find closest town to a given coordinate
 -- 
 -- ===
 --
@@ -83,16 +84,16 @@ TOWNS = {
 
 --- TOWNS class version.
 -- @field #string version
-TOWNS.version="0.0.1"
+TOWNS.version="0.1.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- ToDo list
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 -- TODO: A lot...
--- TODO: Road connection
--- TODO: Rail connection
--- TODO: Connection between towns
+-- DONE: Road connection
+-- DONE: Rail connection
+-- DONE: Connection between towns
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor(s)
@@ -193,14 +194,15 @@ function TOWNS:GetCoordRail(town)
   return town.coordRail
 end
 
---- Get road connection between two towns.
+--- Get road or rail connection between two towns.
 -- @param #TOWNS self
 -- @param #TOWNS.Town townA The town data structure.
 -- @param #TOWNS.Town townB The town data structure.
--- @return #table Table containing path coordinates.
-function TOWNS:GetConnectionRoad(townA, townB)
+-- @param #boolean Railroad If `true`, find rail road connection
+-- @return Core.Pathline#PATHLINE Pathline connecting the two towns on road.
+function TOWNS:GetConnectionRoad(townA, townB, Railroad)
 
-  local path=townA.coordRoad:GetPathOnRoad(townB.coordRoad)
+  local path=townA.coordRoad:GetPathlineOnRoad(townB.coordRoad, false, Railroad)
 
   return path
 end
@@ -208,26 +210,59 @@ end
 --- Find closest town to a given coordinate.
 -- @param #TOWNS self
 -- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @param #table ExcludeList (Optional) List of towns excluded from the search.
 -- @return #TOWNS.Town The closest town.
-function TOWNS:GetClosestTown(Coordinate)
+function TOWNS:GetClosestTown(Coordinate, DistMax, ExcludeList)
 
   local Town=nil --#TOWNS.Town
   local distmin=math.huge
+  ExcludeList=ExcludeList or {}
   
   for _,_town in pairs(self.towns) do
     local town=_town --#TOWNS.Town
     
-    local dist=Coordinate:Get2DDistance(town.coordinate)
+    if (not UTILS.IsInTable(ExcludeList, town, "name")) then
     
-    if dist<distmin then
-      distmin=dist
-      Town=town
+      local dist=Coordinate:Get2DDistance(town.coordinate)
+      
+      if dist<distmin then
+        distmin=dist
+        Town=town
+      end
     end    
   end
   
   return Town
 end
 
+--- Find closest towns to a given coordinate.
+-- @param #TOWNS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number Nmax Max number of towns. Default 5.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @return #table Table of #TOWNS.Town closest towns.
+function TOWNS:GetClosestTowns(Coordinate, Nmax, DistMax)
+
+    Nmax=Nmax or 5
+    
+    local closest={}
+    for i=1,Nmax do
+    
+      local town=self:GetClosestTown(Coordinate, DistMax, closest)
+      
+      if town then
+        table.insert(closest, town)
+      else
+        break
+      end
+      
+    end
+
+  return closest
+end
+
+
 --- Get table of all towns, optionally of a given type.
 -- @param #TOWNS self
 -- @return #table Table of towns. Each element is of type #TOWN.Town.