archive-gh-me/maplibre-rs
1
0
Fork 0
mirror of https://github.com/maplibre/maplibre-rs.git synced 2025-12-08 19:05:57 +00:00
Code Issues Projects Releases Wiki Activity
maplibre-rs/docs/api/maplibre/coords/index.html

13 lines
8.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Provides utilities related to coordinates."><title>maplibre::coords - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="maplibre" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-e32f0c247825364d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../maplibre/index.html">maplibre</a><span class="version">0.1.0</span></h2></div><h2 class="location"><a href="#">Module coords</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate maplibre</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../maplibre/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">maplibre</a>::<wbr><a class="mod" href="#">coords</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/maplibre/coords.rs.html#1-822">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides utilities related to coordinates.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AlignedWorldTileCoords.html" title="struct maplibre::coords::AlignedWorldTileCoords">AlignedWorldTileCoords</a></div><div class="desc docblock-short">An aligned world tile coordinate aligns a world coordinate at a 4x4 tile raster within the
world. The aligned coordinates is defined by the coordinates of the upper left tile in the 4x4
tile raster divided by 2 and rounding to the ceiling.</div></li><li><div class="item-name"><a class="struct" href="struct.InnerCoords.html" title="struct maplibre::coords::InnerCoords">InnerCoords</a></div><div class="desc docblock-short">Within each tile there is a separate coordinate system. Usually this coordinate system is
within <a href="constant.EXTENT.html" title="constant maplibre::coords::EXTENT"><code>EXTENT</code></a>. Therefore, <code>x</code> and <code>y</code> must be within the bounds of <a href="constant.EXTENT.html" title="constant maplibre::coords::EXTENT"><code>EXTENT</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.LatLon.html" title="struct maplibre::coords::LatLon">LatLon</a></div></li><li><div class="item-name"><a class="struct" href="struct.Quadkey.html" title="struct maplibre::coords::Quadkey">Quadkey</a></div><div class="desc docblock-short">Represents the position of a node within a quad tree. The first u8 defines the <code>ZoomLevel</code> of the node.
The remaining bytes define which part (north west, south west, south east, north east) of each
subdivision of the quadtree is concerned.</div></li><li><div class="item-name"><a class="struct" href="struct.TileCoords.html" title="struct maplibre::coords::TileCoords">TileCoords</a></div><div class="desc docblock-short">Every tile has tile coordinates. These tile coordinates are also called
<a href="https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames">Slippy map tile names</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ViewRegion.html" title="struct maplibre::coords::ViewRegion">ViewRegion</a></div><div class="desc docblock-short">Defines a bounding box on a tiled map with a <a href="struct.ZoomLevel.html" title="struct maplibre::coords::ZoomLevel"><code>ZoomLevel</code></a> and a padding.</div></li><li><div class="item-name"><a class="struct" href="struct.WorldCoords.html" title="struct maplibre::coords::WorldCoords">WorldCoords</a></div><div class="desc docblock-short">Actual coordinates within the 3D world. The <code>z</code> value of the [<code>WorldCoors</code>] is not related to
the <code>z</code> value of the [<code>WorldTileCoors</code>]. In the 3D world all tiles are rendered at <code>z</code> values
which are determined only by the render engine and not by the zoom level.</div></li><li><div class="item-name"><a class="struct" href="struct.WorldTileCoords.html" title="struct maplibre::coords::WorldTileCoords">WorldTileCoords</a></div><div class="desc docblock-short">Every tile has tile coordinates. Every tile coordinate can be mapped to a coordinate within
the world. This provides the freedom to map from <a href="https://wiki.openstreetmap.org/wiki/TMS">TMS</a>
to <a href="https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames">Slippy map tile names</a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Zoom.html" title="struct maplibre::coords::Zoom">Zoom</a></div><div class="desc docblock-short"><code>Zoom</code> is an exponential scale that defines the zoom of the camera on the map.
We can derive the <code>ZoomLevel</code> from <code>Zoom</code> by using the <code>[crate::coords::ZOOM_BOUNDS]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ZoomLevel.html" title="struct maplibre::coords::ZoomLevel">ZoomLevel</a></div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.EXTENT.html" title="constant maplibre::coords::EXTENT">EXTENT</a></div></li><li><div class="item-name"><a class="constant" href="constant.EXTENT_SINT.html" title="constant maplibre::coords::EXTENT_SINT">EXTENT_SINT</a></div></li><li><div class="item-name"><a class="constant" href="constant.EXTENT_UINT.html" title="constant maplibre::coords::EXTENT_UINT">EXTENT_UINT</a></div></li><li><div class="item-name"><a class="constant" href="constant.MAX_ZOOM.html" title="constant maplibre::coords::MAX_ZOOM">MAX_ZOOM</a></div></li><li><div class="item-name"><a class="constant" href="constant.TILE_SIZE.html" title="constant maplibre::coords::TILE_SIZE">TILE_SIZE</a></div></li><li><div class="item-name"><a class="constant" href="constant.ZOOM_BOUNDS.html" title="constant maplibre::coords::ZOOM_BOUNDS">ZOOM_BOUNDS</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.create_zoom_bounds.html" title="fn maplibre::coords::create_zoom_bounds">create_zoom_bounds</a><span title="Restricted Visibility">&nbsp;🔒</span> </div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink