Docs updated

Fr0sT-Brutal · Oct 4, 2021 · 2e0af1f · 2e0af1f
1 parent 9f6e2dd
commit 2e0af1f
Show file tree

Hide file tree

Showing 5 changed files with 177 additions and 44 deletions.
diff --git a/docs/docs/AllFunctions.html b/docs/docs/AllFunctions.html
@@ -25,22 +25,22 @@ <h1 class="allitems">All Functions and Procedures</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#EnsureInMap">EnsureInMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Ensures point <code>Pt</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
+<td class="itemdesc"><p>Ensures rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#EnsureInMap">EnsureInMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Ensures rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
+<td class="itemdesc"><p>Ensures point <code>Pt</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
+<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
+<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GetScaleBarParams">GetScaleBarParams</a></td>
@@ -85,12 +85,12 @@ <h1 class="allitems">All Functions and Procedures</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapToGeoCoords">MapToGeoCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts map rect in pixels to geo rect in degrees</p></td>
+<td class="itemdesc"><p>Converts map point in pixels to geo point in degrees</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapToGeoCoords">MapToGeoCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts map point in pixels to geo point in degrees</p></td>
+<td class="itemdesc"><p>Converts map rect in pixels to geo rect in degrees</p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapWidth">MapWidth</a></td>
@@ -145,22 +145,47 @@ <h1 class="allitems">All Functions and Procedures</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToInnerCoords">ToInnerCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert absolute map coords to a point inside a viewport having given top-left point</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToInnerCoords">ToInnerCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert absolute map rect to a rect inside a viewport having given top-left point</p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToOuterCoords">ToOuterCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert a point inside a viewport having given top-left point to absolute map coords</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToOuterCoords">ToOuterCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert a rect inside a viewport having given top-left point to absolute map rect</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileBoundary">ToTileBoundary</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Align absolute map rect to tile boundaries</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileHeightGreater">ToTileHeightGreater</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Ceil vertical map coord to tile size</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileHeightLesser">ToTileHeightLesser</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Floor vertical map coord to tile size</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileWidthGreater">ToTileWidthGreater</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Ceil horizontal map coord to tile size</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileWidthLesser">ToTileWidthLesser</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Floor horizontal map coord to tile size</p></td>
 </tr>
 </table>
 <hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>

diff --git a/docs/docs/AllIdentifiers.html b/docs/docs/AllIdentifiers.html
@@ -75,12 +75,12 @@ <h1 class="allitems">All Identifiers</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#EnsureInMap">EnsureInMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Ensures rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
+<td class="itemdesc"><p>Ensures point <code>Pt</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#EnsureInMap">EnsureInMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Ensures point <code>Pt</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
+<td class="itemdesc"><p>Ensures rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code>, corrects values if necessary </p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.TileStorage.html#GDI_HANDLES_LIMIT">GDI_HANDLES_LIMIT</a></td>
@@ -100,12 +100,12 @@ <h1 class="allitems">All Identifiers</h1>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
+<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GeoCoordsToMap">GeoCoordsToMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Converts geo rect in degrees to map rect in pixels</p></td>
+<td class="itemdesc"><p>Converts geo point in degrees to map point in pixels</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#GetScaleBarParams">GetScaleBarParams</a></td>
@@ -120,12 +120,12 @@ <h1 class="allitems">All Identifiers</h1>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#InMap">InMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Checks if point <code>Pt</code> is inside a map at zoom level <code>Zoom</code></p></td>
+<td class="itemdesc"><p>Checks if rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code></p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#InMap">InMap</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
-<td class="itemdesc"><p>Checks if rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code></p></td>
+<td class="itemdesc"><p>Checks if point <code>Pt</code> is inside a map at zoom level <code>Zoom</code></p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#LabelMargin">LabelMargin</a></td>
@@ -415,12 +415,12 @@ <h1 class="allitems">All Identifiers</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToInnerCoords">ToInnerCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert absolute map coords to a point inside a viewport having given top-left point</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToInnerCoords">ToInnerCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert absolute map rect to a rect inside a viewport having given top-left point</p></td>
 </tr>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#TOnDrawMapMark">TOnDrawMapMark</a></td>
@@ -445,34 +445,59 @@ <h1 class="allitems">All Identifiers</h1>
 <tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToOuterCoords">ToOuterCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert a point inside a viewport having given top-left point to absolute map coords</p></td>
 </tr>
 <tr class="list">
 <td class="itemname"><a class="bold" href="OSM.MapControl.html#ToOuterCoords">ToOuterCoords</a></td>
 <td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
-<td class="itemdesc"><p>&nbsp;</p></td>
+<td class="itemdesc"><p>Convert a rect inside a viewport having given top-left point to absolute map rect</p></td>
 </tr>
 <tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileBoundary">ToTileBoundary</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Align absolute map rect to tile boundaries</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileHeightGreater">ToTileHeightGreater</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Ceil vertical map coord to tile size</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileHeightLesser">ToTileHeightLesser</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Floor vertical map coord to tile size</p></td>
+</tr>
+<tr class="list">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileWidthGreater">ToTileWidthGreater</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Ceil horizontal map coord to tile size</p></td>
+</tr>
+<tr class="list2">
+<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#ToTileWidthLesser">ToTileWidthLesser</a></td>
+<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
+<td class="itemdesc"><p>Floor horizontal map coord to tile size</p></td>
+</tr>
+<tr class="list">
 <td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.TTile.html">TTile</a></td>
 <td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
 <td class="itemdesc"><p>Properties of a map tile</p></td>
 </tr>
-<tr class="list">
+<tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.TileStorage.TTileObjectCache.html">TTileObjectCache</a></td>
 <td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
 <td class="itemdesc"><p>Abstract object cache class indexed by tiles with fixed capacity organised as queue.</p></td>
 </tr>
-<tr class="list2">
+<tr class="list">
 <td class="itemname"><a class="bold" href="OSM.TileStorage.TTileStorage.html">TTileStorage</a></td>
 <td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
 <td class="itemdesc"><p>Class that encapsulates memory and file cache of tile images.</p></td>
 </tr>
-<tr class="list">
+<tr class="list2">
 <td class="itemname"><a class="bold" href="OSM.TileStorage.html#TTileStorageOption">TTileStorageOption</a></td>
 <td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
 <td class="itemdesc"><p>Flags for <a class="normal" href="OSM.TileStorage.TTileStorage.html">TTileStorage</a></p></td>
 </tr>
-<tr class="list2">
+<tr class="list">
 <td class="itemname"><a class="bold" href="OSM.TileStorage.html#TTileStorageOptions">TTileStorageOptions</a></td>
 <td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
 <td class="itemdesc"><p>&nbsp;</p></td>

diff --git a/docs/docs/OSM.MapControl.html b/docs/docs/OSM.MapControl.html
@@ -166,28 +166,36 @@ <h3 class="detail">Functions and Procedures</h3>
 <td class="itemcode"><span id="ToInnerCoords"></span><code>function <strong>ToInnerCoords</strong>(const StartPt, Pt: TPoint): TPoint; overload; inline;</code></td>
 </tr>
 <tr><td colspan="1">
-&nbsp;</td></tr>
+<p>
+Convert absolute map coords to a point inside a viewport having given top-left point</p>
+</td></tr>
 </table>
 <table class="detail wide_list">
 <tr class="list">
 <td class="itemcode"><span id="ToOuterCoords"></span><code>function <strong>ToOuterCoords</strong>(const StartPt, Pt: TPoint): TPoint; overload; inline;</code></td>
 </tr>
 <tr><td colspan="1">
-&nbsp;</td></tr>
+<p>
+Convert a point inside a viewport having given top-left point to absolute map coords</p>
+</td></tr>
 </table>
 <table class="detail wide_list">
 <tr class="list">
 <td class="itemcode"><span id="ToInnerCoords"></span><code>function <strong>ToInnerCoords</strong>(const StartPt: TPoint; const Rect: TRect): TRect; overload; inline;</code></td>
 </tr>
 <tr><td colspan="1">
-&nbsp;</td></tr>
+<p>
+Convert absolute map rect to a rect inside a viewport having given top-left point</p>
+</td></tr>
 </table>
 <table class="detail wide_list">
 <tr class="list">
 <td class="itemcode"><span id="ToOuterCoords"></span><code>function <strong>ToOuterCoords</strong>(const StartPt: TPoint; const Rect: TRect): TRect; overload; inline;</code></td>
 </tr>
 <tr><td colspan="1">
-&nbsp;</td></tr>
+<p>
+Convert a rect inside a viewport having given top-left point to absolute map rect</p>
+</td></tr>
 </table>
 <h3 class="detail">Types</h3>
 <table class="detail wide_list">

diff --git a/docs/docs/OSM.NetworkRequest.TNetworkRequestQueue.html b/docs/docs/OSM.NetworkRequest.TNetworkRequestQueue.html
@@ -39,6 +39,10 @@ <h2 class="description">Description</h2>
 <td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 <td class="itemcode"><code>procedure <strong><a href="OSM.NetworkRequest.TNetworkRequestQueue.html#RequestTile">RequestTile</a></strong>(const Tile: <a href="OSM.SlippyMapUtils.TTile.html">TTile</a>);</code></td>
 </tr>
+<tr class="list2">
+<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
+<td class="itemcode"><code>procedure <strong><a href="OSM.NetworkRequest.TNetworkRequestQueue.html#SetCurrentViewRect">SetCurrentViewRect</a></strong>(const ViewRect: TRect);</code></td>
+</tr>
 </table>
 <span id="PasDoc-Properties"></span><h3 class="summary">Properties</h3>
 <table class="summary wide_list">
@@ -92,6 +96,16 @@ <h6 class="description_section">Parameters</h6>
 Add request for an image for <code>Tile</code> to request queue</p>
 </td></tr>
 </table>
+<table class="detail wide_list">
+<tr class="list">
+<td class="visibility"><a href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
+<td class="itemcode"><span id="SetCurrentViewRect"></span><code>procedure <strong>SetCurrentViewRect</strong>(const ViewRect: TRect);</code></td>
+</tr>
+<tr><td colspan="2">
+<p>
+Set current view rect in absolute map coords. If smart ordering facilities are enabled, tiles inside current view have priority when extracted from request queue.</p>
+</td></tr>
+</table>
 <h3 class="detail">Properties</h3>
 <table class="detail wide_list">
 <tr class="list">
@@ -114,6 +128,7 @@ <h3 class="detail">Properties</h3>
 
 <ul class="paragraph_spacing">
   <li><p>When <a class="normal" href="OSM.NetworkRequest.TNetworkRequestQueue.html#RequestTile">RequestTile</a> adds a tile, all queued items with another zoom level are cancelled (use case: user quickly zooms in/out by multiple steps - no sense to wait for all of them to download)</p></li>
+  <li><p>If current view area is set via <a class="normal" href="OSM.NetworkRequest.TNetworkRequestQueue.html#SetCurrentViewRect">SetCurrentViewRect</a>, the tiles inside this rect are downloaded first (priority of visible area)</p></li>
 </ul>
 
 <p></p>