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 Nov 8, 2022
1 parent ad70292 commit 259a603
Show file tree
Hide file tree
Showing 17 changed files with 592 additions and 216 deletions.
69 changes: 50 additions & 19 deletions docs/docs/AllConstants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,91 +53,122 @@ <h1 class="allitems">All Constants</h1>
<td class="itemdesc"><p>Default pattern of tile file path.</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.RTL.html#EngineCapabilities">EngineCapabilities</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.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.Synapse.html#EngineCapabilities">EngineCapabilities</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.Synapse.html">OSM.NetworkRequest.Synapse</a></td>
<td class="itemdesc"><p>Capabilities of Synapse engine</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.WinInet.html#EngineCapabilities">EngineCapabilities</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.WinInet.html">OSM.NetworkRequest.WinInet</a></td>
<td class="itemdesc"><p>Capabilities of WinInet engine</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.TileStorage.html#GDI_HANDLES_LIMIT">GDI_HANDLES_LIMIT</a></td>
<td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
<td class="itemdesc"><p>Default overall limit is 10k per process, choose reasonable number below this limit</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TileStorage.html#GDI_PER_BMP">GDI_PER_BMP</a></td>
<td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
<td class="itemdesc"><p>Number of GDI handles per <code>TBitmap</code></p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.TileStorage.html#GDI_PER_PNG">GDI_PER_PNG</a></td>
<td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
<td class="itemdesc"><p>Number of GDI handles per <code>TPngImage</code></p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#HTTPProxyProto">HTTPProxyProto</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>Prefix to add to proxy URLs if it only contains host:port - some URL parsers handle such inputs as proto:path</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#HTTPTLSProto">HTTPTLSProto</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersAll">LayersAll</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing all numbers of layers</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#LayersNone">LayersNone</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Constant containing no layers</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#ReqTimeout">ReqTimeout</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>Timeout for connect and request</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#SampleHeaders">SampleHeaders</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>Headers that you could add to <a class="normal" href="OSM.NetworkRequest.TNetworkRequestQueue.html">TNetworkRequestQueue</a>.</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#SampleUserAgent">SampleUserAgent</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>&nbsp;</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#SystemProxy">SystemProxy</a></td>
<td class="itemunit"><a class="bold" href="OSM.NetworkRequest.html">OSM.NetworkRequest</a></td>
<td class="itemdesc"><p>Internal constant to designate OS-wide proxy</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#S_Lbl_Loading">S_Lbl_Loading</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>Default pattern to draw on currently loading tiles</p></td>
</tr>
<tr class="list2">
<tr class="list">
<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> 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>
<td class="itemdesc"><p>See <a href="https://wiki.openstreetmap.org/wiki/Zoom_levels">https://wiki.openstreetmap.org/wiki/Zoom_levels</a> </p>

<pre class="preformatted">
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</pre>

<p></p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.TileStorage.html#TILE_BITMAP_SIZE">TILE_BITMAP_SIZE</a></td>
<td class="itemunit"><a class="bold" href="OSM.TileStorage.html">OSM.TileStorage</a></td>
<td class="itemdesc"><p>Amount of bytes that a single tile bitmap occupies in memory.</p></td>
</tr>
<tr class="list2">
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TILE_IMAGE_HEIGHT">TILE_IMAGE_HEIGHT</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Height of map tile in pixels</p></td>
</tr>
<tr class="list">
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#TILE_IMAGE_WIDTH">TILE_IMAGE_WIDTH</a></td>
<td class="itemunit"><a class="bold" href="OSM.SlippyMapUtils.html">OSM.SlippyMapUtils</a></td>
<td class="itemdesc"><p>Width of map tile in pixels</p></td>
Expand Down
61 changes: 30 additions & 31 deletions docs/docs/AllFunctions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <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 Other</p></td>
<td class="itemdesc"><p>Calculates distance between two geo points in meters</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.html#CheckEngineCap">CheckEngineCap</a></td>
Expand Down Expand Up @@ -70,12 +70,12 @@ <h1 class="allitems">All Functions and Procedures</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.NetworkRequest.html#IsHTTPError">IsHTTPError</a></td>
Expand All @@ -90,7 +90,7 @@ <h1 class="allitems">All Functions and Procedures</h1>
<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 Degrees to pixels</p></td>
<td class="itemdesc"><p>Converts geo coord in degrees to map coord in pixels</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapCoordToLatitude">MapCoordToLatitude</a></td>
Expand All @@ -100,7 +100,7 @@ <h1 class="allitems">All Functions and Procedures</h1>
<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 Pixels to degrees</p></td>
<td class="itemdesc"><p>Converts map coord in pixels to geo coord in degrees</p></td>
</tr>
<tr class="list2">
<td class="itemname"><a class="bold" href="OSM.SlippyMapUtils.html#MapHeight">MapHeight</a></td>
Expand All @@ -110,12 +110,12 @@ <h1 class="allitems">All Functions and Procedures</h1>
<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#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#MapWidth">MapWidth</a></td>
Expand All @@ -125,7 +125,7 @@ <h1 class="allitems">All Functions and Procedures</h1>
<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 Procedure executing a network request.</p></td>
<td class="itemdesc"><p>Procedure executing a network request.</p></td>
</tr>
<tr class="list">
<td class="itemname"><a class="bold" href="OSM.NetworkRequest.Synapse.html#NetworkRequest">NetworkRequest</a></td>
Expand All @@ -148,75 +148,74 @@ <h1 class="allitems">All Functions and Procedures</h1>
<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="list">
<td class="itemname"><a class="bold" href="OSM.MapControl.html#ShiftStateIs">ShiftStateIs</a></td>
<td class="itemunit"><a class="bold" href="OSM.MapControl.html">OSM.MapControl</a></td>
<td class="itemdesc"><p>Determine whether current ShiftState corresponds to desired one (that is, if mouse button and pressed modifiers are the same - not a simple comparison because TShiftState could include additional entries like &quot;Pen&quot;, &quot;Touch&quot; and so on.</p></td>
</tr>
<tr class="list2">
<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>) Tile utils</p></td>
<td class="itemdesc"><p>Returns count of tiles on <code>Zoom</code> level (= <code>2&circ;Zoom</code>)</p></td>
</tr>
<tr class="list2">
<tr class="list">
<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="list">
<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="list2">
<tr class="list">
<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="list">
<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 rect to a rect inside a viewport having given top-left point</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="list2">
<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 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>
<td class="itemdesc"><p>Convert absolute map rect to a rect inside a viewport having given top-left point</p></td>
</tr>
<tr class="list">
<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="list2">
<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="list">
<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="list2">
<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="list">
<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="list2">
<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 Ceil value to tile size</p></td>
<td class="itemdesc"><p>Ceil horizontal map coord to tile size</p></td>
</tr>
<tr class="list">
<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 Floor value to tile size</p></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://pasdoc.github.io/">PasDoc 0.16.0</a>. </em>
Expand Down

0 comments on commit 259a603

Please sign in to comment.