Skip to content

Commit

Permalink
Docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@Fr0sT-Brutal
Fr0sT-Brutal committed Oct 31, 2022
1 parent f8dd5bf commit 595d49f
Show file tree
Hide file tree
Showing 25 changed files with 414 additions and 179 deletions.
13 changes: 9 additions & 4 deletions docs/docs/AllClasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,26 +83,31 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
<td class="itemdesc"><p>Queuer of network requests.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.OpenTopoMap.TOpenTopoMapTilesProvider.html">TOpenTopoMapTilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.OpenTopoMap.html">OSM.TilesProvider.OpenTopoMap</a></td>
<td class="itemdesc"><p>OpenStreetMap tile image provider</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.OSM.TOSMTilesProvider.html">TOSMTilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.OSM.html">OSM.TilesProvider.OSM</a></td>
<td class="itemdesc"><p>OpenStreetMap tile image provider</p></td>
</tr>
<tr class="list">
<tr class="list2">
<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="list2">
<tr class="list">
<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="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.TTilesProvider.html">TTilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.html">OSM.TilesProvider</a></td>
<td class="itemdesc"><p>Abstract base class for tile image provider.</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>
Expand Down
97 changes: 54 additions & 43 deletions docs/docs/AllFunctions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,172 +20,183 @@ <h1 class="allitems">All Functions and Procedures</h1>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#CalcLinDistanceInMeter">CalcLinDistanceInMeter</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Calculates distance between two geo points in meters</p></td>
<td class="itemdesc"><p>Calculates distance between two geo points in meters Other</p></td>
</tr>
<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 point in degrees to map point in pixels</p></td>
<td class="itemname"><a class="bold" href="OSM.TilesProvider.html#FormatTileURL">FormatTileURL</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.html">OSM.TilesProvider</a></td>
<td class="itemdesc"><p>Format URL for a given tile using OpenLayers-compatible URL template.</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 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 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>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Calculates parameters of map scalebar according to zoom level <code>Zoom</code></p></td>
</tr>
<tr class="list">
<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 point <code>Pt</code> is inside a map at zoom level <code>Zoom</code></p></td>
</tr>
<tr class="list2">
<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 rect <code>Rc</code> is inside a map at zoom level <code>Zoom</code></p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#LatitudeToMapCoord">LatitudeToMapCoord</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#LongitudeToMapCoord">LongitudeToMapCoord</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels</p></td>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels Degrees to pixels</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapCoordToLatitude">MapCoordToLatitude</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts map coord in pixels to geo coord in degrees</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapCoordToLongitude">MapCoordToLongitude</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Converts map coord in pixels to geo coord in degrees</p></td>
<td class="itemdesc"><p>Converts map coord in pixels to geo coord in degrees Pixels to degrees</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapHeight">MapHeight</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Returns height of map at zoom level <code>Zoom</code> in pixels</p></td>
</tr>
<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>
</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>
</tr>
<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>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapWidth">MapWidth</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Returns width of map at zoom level <code>Zoom</code> in pixels</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.RTL.html#NetworkRequest">NetworkRequest</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.RTL.html">OSM.NetworkRequest.RTL</a></td>
<td class="itemdesc"><p>Capabilities of RTL engine Function executing a network request.</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.Synapse.html#NetworkRequest">NetworkRequest</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.Synapse.html">OSM.NetworkRequest.Synapse</a></td>
<td class="itemdesc"><p>Function executing a network request.</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.WinInet.html#NetworkRequest">NetworkRequest</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.WinInet.html">OSM.NetworkRequest.WinInet</a></td>
<td class="itemdesc"><p>Function executing a network request.</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#RectFromPoints">RectFromPoints</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Construct <code>TRect</code> from two <code>TPoint</code>-s</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.html#RegisterTilesProvider">RegisterTilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.html">OSM.TilesProvider</a></td>
<td class="itemdesc"><p>Add class of tiles provider to global <a class="normal" href="OSM.TilesProvider.html#TilesProviders">TilesProviders</a> array.</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TileCount">TileCount</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Returns count of tiles on <code>Zoom</code> level (= <code>2&circ;Zoom</code>)</p></td>
<td class="itemdesc"><p>Returns count of tiles on <code>Zoom</code> level (= <code>2&circ;Zoom</code>) Tile utils</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TilesEqual">TilesEqual</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Compares tiles</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TileToStr">TileToStr</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Returns standartized string representation of <code>Tile</code></p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TileValid">TileValid</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Checks <code>Tile</code> fields for validity</p></td>
</tr>
<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>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>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="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>Convert a point inside a viewport having given top-left point to absolute map coords</p></td>
<td class="itemdesc"><p>Convert absolute map coords to a point inside a viewport having given top-left point <strong></p>

<ul class="paragraph_spacing">
<li><p>Utils</p></li>
</ul>

<p></strong>* Like Client&lt;=&gt;Screen</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>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.MapControl.html#ToOuterCoords">ToOuterCoords</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></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.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">
<tr class="list2">
<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">
<tr class="list">
<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">
<tr class="list2">
<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>
<td class="itemdesc"><p>Ceil horizontal map coord to tile size Ceil value to tile size</p></td>
</tr>
<tr class="list2">
<tr class="list">
<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>
<td class="itemdesc"><p>Floor horizontal map coord to tile size Floor value to tile size</p></td>
</tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
Expand Down

0 comments on commit 595d49f

Please sign in to comment.