Skip to content

Commit

Permalink
update output HTML
Browse files Browse the repository at this point in the history
  • Loading branch information
@merlos
merlos committed Sep 27, 2020
1 parent 1df9d76 commit c96bae8
Show file tree
Hide file tree
Showing 94 changed files with 5,068 additions and 472 deletions.
46 changes: 44 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
<li class="nav-group-task">
<a href="Classes/CachedTileOverlay.html">CachedTileOverlay</a>
</li>
<li class="nav-group-task">
<a href="Classes/CachedTileOverlayRenderer.html">CachedTileOverlayRenderer</a>
</li>
<li class="nav-group-task">
<a href="Classes/DiskCache.html">DiskCache</a>
</li>
Expand Down Expand Up @@ -103,6 +106,9 @@
<li class="nav-group-task">
<a href="Extensions/MKTileOverlayPath.html">MKTileOverlayPath</a>
</li>
<li class="nav-group-task">
<a href="Extensions/MKZoomScale.html">MKZoomScale</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSMutableData.html">NSMutableData</a>
</li>
Expand Down Expand Up @@ -172,6 +178,9 @@
<li class="nav-group-task">
<a href="Structs/ZoomRangeIterator.html">ZoomRangeIterator</a>
</li>
<li class="nav-group-task">
<a href="Structs/ZoomableTile.html">ZoomableTile</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -214,7 +223,7 @@ <h1>Classes</h1>
This class overrides the default <code>MKTileOverlay</code>to provide support to <code><a href="Classes/MapCache.html">MapCache</a></code>.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
MkMapView+MapView
<code>MkMapView+MapCache</code>

</div>

Expand All @@ -231,6 +240,39 @@ <h4>Declaration</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@MapCache@objc(cs)CachedTileOverlayRenderer"></a>
<a name="//apple_ref/swift/Class/CachedTileOverlayRenderer" class="dashAnchor"></a>
<a class="token" href="#/c:@M@MapCache@objc(cs)CachedTileOverlayRenderer">CachedTileOverlayRenderer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A Tile overlay that supports to zoom beyond the maximumZ</p>

<p>Tile servers allow from 1 to a certain zoom level typically between 16 and 21 (set in <code><a href="Structs/MapCacheConfig.html#/s:8MapCache0aB6ConfigV8maximumZSivp">MapCacheConfig.maximumZ</a></code>).
Beyond that zoom levels tiles are not available in the server</p>

<p>This renderer takes the maximumZ tile and extracts the portion that would correspond to the requested level.</p>

<a href="Classes/CachedTileOverlayRenderer.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">CachedTileOverlayRenderer</span> <span class="p">:</span> <span class="kt">MKTileOverlayRenderer</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -503,7 +545,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/merlos/MapCache" target="_blank" rel="external">merlos</a>. All rights reserved. (Last updated: 2020-09-26)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/merlos/MapCache" target="_blank" rel="external">merlos</a>. All rights reserved. (Last updated: 2020-09-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
111 changes: 103 additions & 8 deletions docs/Classes/CachedTileOverlay.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
<li class="nav-group-task">
<a href="../Classes/CachedTileOverlay.html">CachedTileOverlay</a>
</li>
<li class="nav-group-task">
<a href="../Classes/CachedTileOverlayRenderer.html">CachedTileOverlayRenderer</a>
</li>
<li class="nav-group-task">
<a href="../Classes/DiskCache.html">DiskCache</a>
</li>
Expand Down Expand Up @@ -103,6 +106,9 @@
<li class="nav-group-task">
<a href="../Extensions/MKTileOverlayPath.html">MKTileOverlayPath</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/MKZoomScale.html">MKZoomScale</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/NSMutableData.html">NSMutableData</a>
</li>
Expand Down Expand Up @@ -172,6 +178,9 @@
<li class="nav-group-task">
<a href="../Structs/ZoomRangeIterator.html">ZoomRangeIterator</a>
</li>
<li class="nav-group-task">
<a href="../Structs/ZoomableTile.html">ZoomableTile</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -202,7 +211,7 @@ <h1>CachedTileOverlay</h1>
This class overrides the default <code>MKTileOverlay</code>to provide support to <code><a href="../Classes/MapCache.html">MapCache</a></code>.</p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
MkMapView+MapView
<code>MkMapView+MapCache</code>

</div>

Expand Down Expand Up @@ -301,7 +310,7 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>the cache to be used on loadTile</p>
<p>the cache to be used on <code>loadTile</code></p>
</div>
</td>
</tr>
Expand All @@ -325,10 +334,10 @@ <h4>Parameters</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Generates the URL for the tile to be requested.
It replaces the values of {z},{x} and {y} in the urlTemplate defined in GPXTileServer</p>
It replaces the values of {z},{x} and {y} in the <code>urlTemplate</code>defined in <code>mapCache.config</code></p>
<div class="aside aside-see-also">
<p class="aside-title">See also</p>
GPXTileServer
<code><a href="../Classes/MapCache.html">MapCache</a></code>, <code><a href="../Structs/MapCacheConfig.html">MapCacheConfig</a></code>

</div>

Expand Down Expand Up @@ -357,28 +366,114 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Depending on <code><a href="../Classes/CachedTileOverlay.html#/s:8MapCache17CachedTileOverlayC03useB0Sbvp">useCache</a></code>value, when invoked, will load the tile using the standard OS
implementation or from the cache.</p>
<p>When invoked it will load the tile using the standard OS implementation (if <code><a href="../Classes/CachedTileOverlay.html#/s:8MapCache17CachedTileOverlayC03useB0Sbvp">useCache</a></code>is <code>false</code>)
or from the cache (if <code><a href="../Classes/CachedTileOverlay.html#/s:8MapCache17CachedTileOverlayC03useB0Sbvp">useCache</a></code> is <code>true</code></p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">loadTile</span><span class="p">(</span><span class="n">at</span> <span class="nv">path</span><span class="p">:</span> <span class="kt">MKTileOverlayPath</span><span class="p">,</span>
<span class="nv">result</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Data</span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
<span class="nv">result</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Data</span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8MapCache17CachedTileOverlayC10shouldZoom2atSb12CoreGraphics7CGFloatV_tF"></a>
<a name="//apple_ref/swift/Method/shouldZoom(at:)" class="dashAnchor"></a>
<a class="token" href="#/s:8MapCache17CachedTileOverlayC10shouldZoom2atSb12CoreGraphics7CGFloatV_tF">shouldZoom(at:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tells whether or not to upsample and show a lesser detailed z level
takes into account <code>useZoom</code> configuration as well as current and <code>maximumZ</code> values</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">shouldZoom</span><span class="p">(</span><span class="n">at</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">MKZoomScale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8MapCache17CachedTileOverlayC07tilesInA4Rect4rect5scaleSayAA08ZoomableD0VGSo05MKMapH0a_12CoreGraphics7CGFloatVtF"></a>
<a name="//apple_ref/swift/Method/tilesInMapRect(rect:scale:)" class="dashAnchor"></a>
<a class="token" href="#/s:8MapCache17CachedTileOverlayC07tilesInA4Rect4rect5scaleSayAA08ZoomableD0VGSo05MKMapH0a_12CoreGraphics7CGFloatVtF">tilesInMapRect(rect:<wbr>scale:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Given the maximum zoom level for the tileset <code>(mapCache.config.maximumZ</code>) it will return the tile, map rects, and additional scaling factor for upscaling tiles.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">tilesInMapRect</span><span class="p">(</span><span class="nv">rect</span><span class="p">:</span> <span class="kt">MKMapRect</span><span class="p">,</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">MKZoomScale</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt"><a href="../Structs/ZoomableTile.html">ZoomableTile</a></span><span class="p">]</span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>rect</em>
</code>
</td>
<td>
<div>
<p>map rectangle for which we want to get the tile set</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>scale</em>
</code>
</td>
<td>
<div>
<p>current zoom scale</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/merlos/MapCache" target="_blank" rel="external">merlos</a>. All rights reserved. (Last updated: 2020-09-26)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/merlos/MapCache" target="_blank" rel="external">merlos</a>. All rights reserved. (Last updated: 2020-09-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit c96bae8

Please sign in to comment.