fix(webgraph): read notes

- legacy code ported from 1400 was offsetting webgraph wrongly as it's not needed anymore
- optimized TRSMap cache setup slightly
- docs

Author: Torwent

osrs/interfaces/minimap.simba

@@ -45,6 +45,7 @@ Main record used to interact with the {ref}`Minimap`.
     Orbs: array of TRSMinimapOrb;
     Bounds: TBox;
     Center: TPoint;
+    Radius: Integer;
     Polygon: TPolygon;
 
     Compass: record
@@ -90,6 +91,8 @@ begin
         Self.Bounds.Y1 := Y1 + 8;
         Self.Bounds.Y2 := Y1 + 159;
       end;
+
+      Self.Radius := 71;
     end;
 
     ERSMode.FIXED:
@@ -104,6 +107,8 @@ begin
         Self.Bounds.Y1 := Y1 + 9;
         Self.Bounds.Y2 := Y1 + 159;
       end;
+
+      Self.Radius := 65;
     end;
   end;
 
@@ -844,12 +849,7 @@ begin
   if angle = $FFFF then angle := Self.GetCompassAngle(False);
 
   if radius = -1 then
-    case RSClient.Mode of
-      ERSMode.FIXED:
-        radius := 65;
-      ERSMode.RESIZABLE, ERSMode.MODERN_COMPACT, ERSMode.MODERN_WIDE:
-        radius := 71;
-    end;
+    radius := Self.Radius;
 
   img := Target.GetImage(Self.Bounds);
   img.ReplaceColor($0, $1);
@@ -903,12 +903,7 @@ begin
   Result := img.Copy();
 
   if radius = -1 then
-    case RSClient.Mode of
-      ERSMode.FIXED:
-        radius := 65;
-      ERSMode.RESIZABLE, ERSMode.MODERN_COMPACT, ERSMode.MODERN_WIDE:
-        radius := 71;
-    end;
+    radius := Self.Radius;
 
   Result.Crop(TBox.Create(Result.Center, radius, radius));
   tpa := Result.FindColor($0, 0).SortFrom(Result.Center);

osrs/interfaces/setup.simba

@@ -115,6 +115,7 @@ begin
   FormUtils.Setup();
   RSFonts.Setup();
   Logger.Setup();
+  WebGraphGenerator.Setup();
 
   {$IFDEF WL_TEST}
   RSClient.Client := ERSClient.RUNELITE;

osrs/position/map/map.simba

@@ -85,7 +85,10 @@ begin
   if Self.Sample.Amount = 0 then Self.Sample.Amount := 4;
   if Self.Sample.Radius = 0 then Self.Sample.Radius := -1;
 
-  img := Minimap.GetCleanImage($FFFF, Self.Sample.Radius);
+  if Minimap.Radius = 0 then
+    raise GetDebugLn('Minimap.Radius is set to 0, did you target the client?');
+  img := new TImage(Minimap.Radius*2+1,Minimap.Radius*2+1);
+  img.ReplaceColor($0, $FFFFFF);
   sample := Minimap.ScaleMinimap(img, Self.Loader.Downscale, Self.Sample.Radius);
 
   Self.Cache.MatchTemplate := TMatchTemplateCache.Create(Self.Loader.DownscaledMap, sample, ETMFormula.TM_CCOEFF_NORMED);

osrs/position/map/maploader.simba

@@ -488,13 +488,11 @@ var
   region: TRSMapRegion;
   i, j, k, plane, regionCount: Integer;
   maps, heightmaps, collisionmaps: TImageArray;
-  topLeft, btmRight: TPoint;
+  topLeft, btmRight, offset: TPoint;
   graphs: array of TWebGraph;
-  boxes: TBoxArray;
+  boxes, oldRegions: TBoxArray;
   newMap, newHeightmap, newCollision: TImage;
-  existingBox: TBox;
-  oldRegions: array of TBox;
-  offset: TPoint;
+  oldMapBox: TBox;
 begin
   if Self.Downscale <> downscale then
     raise GetDebugLn('MapLoader', 'Cannot add chunks with different downscale value');
@@ -529,7 +527,6 @@ begin
       maps += Self.GetMap(region.Chunks, plane, ERSMap.NORMAL);
       maps.Last.Pad(padding);
 
-      //heightmap are shared accross planes
       heightmaps += Self.GetMap(region.Chunks, plane, ERSMap.HEIGHT);
       heightmaps.Last.Pad(padding);
 
@@ -544,18 +541,20 @@ begin
       Self.Regions += region;
     end;
 
-  if Length(Self.Regions) = regionCount then Exit;
+  if Length(Self.Regions) = regionCount then
+    Exit;
 
   SetLength(oldRegions, regionCount);
   for i := 0 to regionCount - 1 do
+  begin
     oldRegions[i] := Self.Regions[i].Region;
-
-  for i := 0 to regionCount - 1 do
     boxes.Insert(Self.Regions[i].Region, i);
+  end;
 
   boxes := boxes.Pack();
-  existingBox := Self.MapBox;
+  oldMapBox := Self.MapBox;
   Self.MapBox := [];
+
   for i := 0 to High(boxes) do
   begin
     Self.Regions[i].Region := boxes[i];
@@ -566,97 +565,74 @@ begin
   newHeightmap := new TImage(Self.MapBox.Width, Self.MapBox.Height);
   newCollision := new TImage(Self.MapBox.Width, Self.MapBox.Height);
 
-  if (existingBox.Width > 0) and (existingBox.Height > 0) then
+  for i := 0 to regionCount - 1 do
   begin
-    for i := 0 to regionCount - 1 do
-    begin
-      newMap.DrawImage(Self.Map.Copy(oldRegions[i]), Self.Regions[i].Region.TopLeft);
-      if Assigned(Self.Heightmap) then
-        newHeightmap.DrawImage(Self.Heightmap.Copy(oldRegions[i]), Self.Regions[i].Region.TopLeft);
-      newCollision.DrawImage(Self.Collision.Copy(oldRegions[i]), Self.Regions[i].Region.TopLeft);
-    end;
+    topLeft := Self.Regions[i].Region.TopLeft;
+    newMap.DrawImage(Self.Map.Copy(oldRegions[i]), topLeft);
+    newHeightmap.DrawImage(Self.Heightmap.Copy(oldRegions[i]), topLeft);
+    newCollision.DrawImage(Self.Collision.Copy(oldRegions[i]), topLeft);
   end;
 
   for i := regionCount to High(Self.Regions) do
   begin
-    newMap.DrawImage(maps[i - regionCount], Self.Regions[i].Region.TopLeft);
-    if i - regionCount < Length(heightmaps) then
-      newHeightmap.DrawImage(heightmaps[i - regionCount], Self.Regions[i].Region.TopLeft);
-    newCollision.DrawImage(collisionmaps[i - regionCount], Self.Regions[i].Region.TopLeft);
+    j := i - regionCount;
+    topLeft := Self.Regions[i].Region.TopLeft;
+    newMap.DrawImage(maps[j], topLeft);
+    newHeightmap.DrawImage(heightmaps[j], topLeft);
+    newCollision.DrawImage(collisionmaps[j], topLeft);
   end;
 
   Self.Map := newMap;
-  if Length(heightmaps) > 0 then
-    Self.Heightmap := newHeightmap;
+  Self.Heightmap := newHeightmap;
   Self.Collision := newCollision;
 
   Self.HalfMap := Self.Map.Downsample(2);
   Self.DownscaledMap := Self.Map.Downsample(Self.Downscale);
 
-  if not WebGraphGenerator.Disabled then
+  if WebGraphGenerator.Disabled then Exit;
+
+  for i := 0 to regionCount - 1 do
   begin
-    for i := 0 to regionCount - 1 do
-    begin
-      offset := Self.Regions[i].Region.TopLeft - oldRegions[i].TopLeft;
-
-      if offset <> [0, 0] then
-      begin
-        for j := 0 to High(Self.Graph.Nodes) do
-          if Self.Graph.Nodes[j] in oldRegions[i] then
-            Self.Graph.Nodes[j] := Self.Graph.Nodes[j] + offset;
-
-        for j := 0 to High(Self.Graph.WalkableSpace) do
-          if Self.Graph.WalkableSpace[j] in oldRegions[i] then
-            Self.Graph.WalkableSpace[j] := Self.Graph.WalkableSpace[j] + offset;
-
-        for j := 0 to High(Self.Graph.WalkableClusters) do
-          for k := 0 to High(Self.Graph.WalkableClusters[j]) do
-            if Self.Graph.WalkableClusters[j][k] in oldRegions[i] then
-              Self.Graph.WalkableClusters[j][k] := Self.Graph.WalkableClusters[j][k] + offset;
-
-        for j := 0 to High(Self.Graph.ObjectClusters) do
-          for k := 0 to High(Self.Graph.ObjectClusters[j]) do
-            if Self.Graph.ObjectClusters[j][k] in oldRegions[i] then
-              Self.Graph.ObjectClusters[j][k] := Self.Graph.ObjectClusters[j][k] + offset;
-
-        for j := 0 to High(Self.Graph.Doors) do
-          if Self.Graph.Doors[j].Center in oldRegions[i] then
-          begin
-            Self.Graph.Doors[j].Before := Self.Graph.Doors[j].Before + offset;
-            Self.Graph.Doors[j].After := Self.Graph.Doors[j].After + offset;
-            Self.Graph.Doors[j].Center := Self.Graph.Doors[j].Center + offset;
-          end;
-      end;
-    end;
+    offset := Self.Regions[i].Region.TopLeft - oldRegions[i].TopLeft;
 
-    for i := 0 to High(graphs) do
+    if offset <> [0, 0] then
     begin
-      offset := Self.Regions[regionCount + i].Region.TopLeft;
-
-      graphs[i].Nodes := graphs[i].Nodes.Offset(offset);
-      graphs[i].WalkableSpace := graphs[i].WalkableSpace.Offset(offset);
-
-      for j := 0 to High(graphs[i].WalkableClusters) do
-        graphs[i].WalkableClusters[j] := graphs[i].WalkableClusters[j].Offset(offset);
-
-      for j := 0 to High(graphs[i].ObjectClusters) do
-        graphs[i].ObjectClusters[j] := graphs[i].ObjectClusters[j].Offset(offset);
+      for j := 0 to High(Self.Graph.Nodes) do
+        if Self.Graph.Nodes[j] in oldRegions[i] then
+          Self.Graph.Nodes[j] := Self.Graph.Nodes[j] + offset;
+
+      for j := 0 to High(Self.Graph.WalkableSpace) do
+        if Self.Graph.WalkableSpace[j] in oldRegions[i] then
+          Self.Graph.WalkableSpace[j] := Self.Graph.WalkableSpace[j] + offset;
+
+      for j := 0 to High(Self.Graph.WalkableClusters) do
+        for k := 0 to High(Self.Graph.WalkableClusters[j]) do
+          if Self.Graph.WalkableClusters[j][k] in oldRegions[i] then
+            Self.Graph.WalkableClusters[j][k] := Self.Graph.WalkableClusters[j][k] + offset;
+
+      for j := 0 to High(Self.Graph.ObjectClusters) do
+        for k := 0 to High(Self.Graph.ObjectClusters[j]) do
+          if Self.Graph.ObjectClusters[j][k] in oldRegions[i] then
+            Self.Graph.ObjectClusters[j][k] := Self.Graph.ObjectClusters[j][k] + offset;
+
+      for j := 0 to High(Self.Graph.Doors) do
+        if Self.Graph.Doors[j].Center in oldRegions[i] then
+        begin
+          Self.Graph.Doors[j].Before := Self.Graph.Doors[j].Before + offset;
+          Self.Graph.Doors[j].After := Self.Graph.Doors[j].After + offset;
+          Self.Graph.Doors[j].Center := Self.Graph.Doors[j].Center + offset;
+        end;
+    end;
 
-      for j := 0 to High(graphs[i].Doors) do
-      begin
-        graphs[i].Doors[j].Before := graphs[i].Doors[j].Before + offset;
-        graphs[i].Doors[j].After := graphs[i].Doors[j].After + offset;
-        graphs[i].Doors[j].Center := graphs[i].Doors[j].Center + offset;
-      end;
+  end;
 
-      Self.Graph.Merge(graphs[i]);
-    end;
+  for i := 0 to High(graphs) do
+    Self.Graph.Merge(graphs[i]);
 
-    for i := 0 to High(Self.Graph.Doors) do
-    begin
-      Self.Graph.Doors[i].Before := RSTranslator.Normalize(Self.Graph.Doors[i].Before);
-      Self.Graph.Doors[i].After := RSTranslator.Normalize(Self.Graph.Doors[i].After);
-    end;
+  for i := 0 to High(Self.Graph.Doors) do
+  begin
+    Self.Graph.Doors[i].Before := RSTranslator.Normalize(Self.Graph.Doors[i].Before);
+    Self.Graph.Doors[i].After := RSTranslator.Normalize(Self.Graph.Doors[i].After);
   end;
 end;
 

utils/webgraphgen.simba

@@ -24,6 +24,34 @@ begin
   Result := HashData(EHashAlgo.CRC32, @data[0], Length(data));
 end;
 
+(*
+## WebGraphGenerator.Setup
+```pascal
+procedure TWebGraphGenerator.Setup();
+```
+Sets up the `TWebGraphGenerator` with the following settings which are the
+defaults:
+```pascal
+WebGraphGenerator.Spacing := 18;         //low = better/slower, high = worse/faster
+WebGraphGenerator.MinimumTiles := 4;     //spaces with less tiles than this will be ignored.
+WebGraphGenerator.NodeRadius := 50;      //closed space less than NodeRadius pixels will have a single node.
+WebGraphGenerator.MaxConnections := 6;   //Max connections per node.
+WebGraphGenerator.WallCrossings := True; //Whether to allow wall crossings when there's a close path around it.
+```
+
+Feel free to change the settings to suit your need and use the
+{ref}`Map Debugger` to see what the results look like.
+
+To do so you **MUST DO IT BEFORE** setting up your {ref}`Map`.
+*)
+procedure TWebGraphGenerator.Setup();
+begin
+  Self.Spacing := 18;
+  Self.MinimumTiles := 4;
+  Self.NodeRadius := 50;
+  Self.MaxConnections := 6;
+  Self.WallCrossings := True;
+end;
 
 function TWebGraphGenerator.GetDoorDirection(center: TPoint; img: TImage): TPoint;
 var
@@ -192,12 +220,11 @@ begin
 end;
 
 
-
 (*
-## TRSChunkLoader.BuildGraph
+## WebGraphGenerator.BuildGraph
 ```pascal
-function TRSChunkLoader._BuildGraph(map: TMufasaBitmap; white, red: TPointArray): TWebGraphV2;
-function TRSChunkLoader.BuildGraph(name: String; map: TMufasaBitmap): TWebGraphV2;
+function TWebGraphGenerator._BuildGraph(map: TImage; white, red: TPointArray): TWebGraph;
+function TWebGraphGenerator.BuildGraph(name: String; map: TImage): TWebGraph;
 ```
 Magically builds a webgraph for you for a given collision map passed into `map`.
 
@@ -210,6 +237,28 @@ The collision map can only have 4 colors:
 ```{note}
 This is an internal method. Don't use it if you don't know what you are doing.
 ```
+
+It's hard to go into detail on how this works but if you want to see the result
+run this example code:
+```pascal
+{$I WaspLib/osrs.simba}
+begin
+  Map.Setup([Chunk(Box(49,54,50,53), 0)]);
+  Map.Debug();
+end.
+```
+
+This will setup a map with a small piece of varrock and then open the
+{ref}`Map Debugger`.
+
+On the {ref}`Map Debugger` change the dropdown to the collision map if you want
+to see what it looks like, that is what will go through this as the `map`
+parameter and it should look something like this:
+
+```{figure} ../../images/map_collision.png
+```
+
+As a bonus you can also see the resulting webgraph!
 *)
 function TWebGraphGenerator._BuildGraph(map: TImage; white, red: TPointArray): TWebGraph;
 var
@@ -344,7 +393,6 @@ begin
   SetLength(Result.Names, Length(Result.Nodes));
 end;
 
-
 function TWebGraphGenerator.BuildGraph(name: String; map: TImage): TWebGraph;
 var
   white, red, gray, merged, graySubset: TPointArray;
@@ -393,11 +441,3 @@ var
 Global {ref}`TWebGraphGenerator` variable.
 *)
   WebGraphGenerator: TWebGraphGenerator;
-
-begin
-  WebGraphGenerator.Spacing := 18;         //low = better/slower, high = worse/faster
-  WebGraphGenerator.MinimumTiles := 4;     //spaces with less tiles than this will be ignored.
-  WebGraphGenerator.NodeRadius := 50;      //closed space less than NodeRadius pixels will have a single node.
-  WebGraphGenerator.MaxConnections := 6;   //Max connections per node.
-  WebGraphGenerator.WallCrossings := True; //Whether to allow wall crossings when there's a close path around it.
-end;