Skip to content

Commit

Permalink
Docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@Fr0sT-Brutal
Fr0sT-Brutal committed Sep 19, 2022
1 parent 9ac8c64 commit 658bda3
Show file tree
Hide file tree
Showing 38 changed files with 932 additions and 385 deletions.
34 changes: 27 additions & 7 deletions docs/docs/AllClasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<head>
<title>OSM Map control: All Classes, Interfaces, Objects and Records</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2><a href="index.html" class="navigation">OSM Map control</a></h2><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<div class="container"><div class="navigation">
<h2><a href="index.html">OSM Map control</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li></ul></div><div class="content">
<h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
<table class="itemstable wide_list">
<tr class="listheader">
Expand All @@ -23,15 +23,25 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
<td class="itemdesc"><p>Limits of tile cache in memory</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.TDummyTilesProvider.html">TDummyTilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.html">OSM.TilesProvider</a></td>
<td class="itemdesc"><p>Dummy tile provider class, used as a stub in map control if no real provider is assigned.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.TGeoPoint.html">TGeoPoint</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Point on a map defined by longitude and latitude.</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.TGeoRect.html">TGeoRect</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Region on a map defined by two pairs of longitude and latitude.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.TilesProvider.HERE.THERETilesProvider.html">THERETilesProvider</a></td>
<td class="itemunit"><a class="bold" href="OSM.TilesProvider.HERE.html">OSM.TilesProvider.HERE</a></td>
<td class="itemdesc"><p>HERE tile image provider</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.THttpRequestProps.html">THttpRequestProps</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
Expand Down Expand Up @@ -68,21 +78,31 @@ <h1 class="allitems">All Classes, Interfaces, Objects and Records</h1>
<td class="itemdesc"><p>Queuer of network requests.</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="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="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="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>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</td></tr></table></body></html>
</div></div></body></html>
12 changes: 6 additions & 6 deletions docs/docs/AllConstants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<head>
<title>OSM Map control: All Constants</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2><a href="index.html" class="navigation">OSM Map control</a></h2><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<div class="container"><div class="navigation">
<h2><a href="index.html">OSM Map control</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li></ul></div><div class="content">
<h1 class="allitems">All Constants</h1>
<table class="itemstable wide_list">
<tr class="listheader">
Expand Down Expand Up @@ -115,7 +115,7 @@ <h1 class="allitems">All Constants</h1>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TileMetersPerPixelOnEquator">TileMetersPerPixelOnEquator</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>See <a href="https://wiki.openstreetmap.org/wiki/Zoom_levels">https://wiki.openstreetmap.org/wiki/Zoom_levels</a></p></td>
<td class="itemdesc"><p>See <a href="https://wiki.openstreetmap.org/wiki/Zoom_levels">https://wiki.openstreetmap.org/wiki/Zoom_levels</a> Level Degree Area m / pixel &tilde;Scale # Tiles 0 360 whole world 156,412 1:500 million 1 1 180 78,206 1:250 million 4 2 90 39,103 1:150 million 16 3 45 19,551 1:70 million 64 4 22.5 9,776 1:35 million 256 5 11.25 4,888 1:15 million 1,024 6 5.625 2,444 1:10 million 4,096 7 2.813 1,222 1:4 million 16,384 8 1.406 610.984 1:2 million 65,536 9 0.703 wide area 305.492 1:1 million 262,144 10 0.352 152.746 1:500,000 1,048,576 11 0.176 area 76.373 1:250,000 4,194,304 12 0.088 38.187 1:150,000 16,777,216 13 0.044 village/town 19.093 1:70,000 67,108,864 14 0.022 9.547 1:35,000 268,435,456 15 0.011 4.773 1:15,000 1,073,741,824 16 0.005 small road 2.387 1:8,000 4,294,967,296 17 0.003 1.193 1:4,000 17,179,869,184 18 0.001 0.596 1:2,000 68,719,476,736 19 0.0005 0.298 1:1,000 274,877,906,944 20 0.00025 mid-sized bldng 0.149 1:5,00 1,099,511,627,776</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.TileStorage.html#TILE_BITMAP_SIZE">TILE_BITMAP_SIZE</a></td>
Expand All @@ -133,6 +133,6 @@ <h1 class="allitems">All Constants</h1>
<td class="itemdesc"><p>Width of map tile in pixels</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>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</td></tr></table></body></html>
</div></div></body></html>
51 changes: 23 additions & 28 deletions docs/docs/AllFunctions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<head>
<title>OSM Map control: All Functions and Procedures</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.15.0">
<meta name="generator" content="PasDoc 0.16.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2><a href="index.html" class="navigation">OSM Map control</a></h2><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<div class="container"><div class="navigation">
<h2><a href="index.html">OSM Map control</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li></ul></div><div class="content">
<h1 class="allitems">All Functions and Procedures</h1>
<table class="itemstable wide_list">
<tr class="listheader">
Expand All @@ -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 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.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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -128,66 +128,61 @@ <h1 class="allitems">All Functions and Procedures</h1>
<td class="itemdesc"><p>Compares tiles</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TileToFullSlippyMapFileURL">TileToFullSlippyMapFileURL</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Returns full URL to an image of tile <code>Tile</code> using global variables <a class="normal" href="OSM.SlippyMapUtils.html#MapURLPrefix">MapURLPrefix</a>, <a class="normal" href="OSM.SlippyMapUtils.html#TileURLPatt">TileURLPatt</a>, <a class="normal" href="OSM.SlippyMapUtils.html#MapURLPostfix">MapURLPostfix</a></p></td>
</tr>
<tr class="list2">
<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</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>
</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>
</tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc 0.15.0</a>. </em>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
</span>
</td></tr></table></body></html>
</div></div></body></html>

0 comments on commit 658bda3

Please sign in to comment.