a-b-street/abstreet
1
1
Fork 0
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-21 05:11:42 +03:00
Code Issues Projects Releases Wiki Activity
a1528fa193
abstreet/rustdoc/map_gui/tools/index.html
dabreegster 0e0916af18 deploy: b6e5c4e256
2021-08-29 15:30:51 +00:00

29 lines
13 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="Assorted tools and UI states that’re useful for applications built to display maps."><meta name="keywords" content="rust, rustlang, rust-lang, tools"><title>map_gui::tools - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../map_gui/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module tools</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="tools" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">map_gui</a>::<wbr><a class="mod" href="#">tools</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/map_gui/tools/mod.rs.html#1-280" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Assorted tools and UI states that’re useful for applications built to display maps.</p>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<table><tr class="module-item"><td><a class="mod" href="camera/index.html" title="map_gui::tools::camera mod">camera</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="city_picker/index.html" title="map_gui::tools::city_picker mod">city_picker</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="colors/index.html" title="map_gui::tools::colors mod">colors</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="command/index.html" title="map_gui::tools::command mod">command</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="heatmap/index.html" title="map_gui::tools::heatmap mod">heatmap</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="icons/index.html" title="map_gui::tools::icons mod">icons</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="importer/index.html" title="map_gui::tools::importer mod">importer</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="minimap/index.html" title="map_gui::tools::minimap mod">minimap</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="navigate/index.html" title="map_gui::tools::navigate mod">navigate</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="turn_explorer/index.html" title="map_gui::tools::turn_explorer mod">turn_explorer</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="ui/index.html" title="map_gui::tools::ui mod">ui</a></td><td class="docblock-short"><p>Generic UI tools. Some of this should perhaps be lifted to widgetry.</p>
</td></tr><tr class="module-item"><td><a class="mod" href="updater/index.html" title="map_gui::tools::updater mod">updater</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="url/index.html" title="map_gui::tools::url mod">url</a></td><td class="docblock-short"></td></tr></table><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.CameraState.html" title="map_gui::tools::CameraState struct">CameraState</a></td><td class="docblock-short"><p>Represents the state of a widgetry Canvas.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ChooseSomething.html" title="map_gui::tools::ChooseSomething struct">ChooseSomething</a></td><td class="docblock-short"><p>Choose something from a menu, then feed the answer to a callback.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CityPicker.html" title="map_gui::tools::CityPicker struct">CityPicker</a></td><td class="docblock-short"><p>Lets the player switch maps.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ColorDiscrete.html" title="map_gui::tools::ColorDiscrete struct">ColorDiscrete</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.ColorLegend.html" title="map_gui::tools::ColorLegend struct">ColorLegend</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.ColorNetwork.html" title="map_gui::tools::ColorNetwork struct">ColorNetwork</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.ColorScale.html" title="map_gui::tools::ColorScale struct">ColorScale</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.DefaultMap.html" title="map_gui::tools::DefaultMap struct">DefaultMap</a></td><td class="docblock-short"><p>Track the last map used, to resume next session.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DivergingScale.html" title="map_gui::tools::DivergingScale struct">DivergingScale</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.FilePicker.html" title="map_gui::tools::FilePicker struct">FilePicker</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Grid.html" title="map_gui::tools::Grid struct">Grid</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.HeatmapOptions.html" title="map_gui::tools::HeatmapOptions struct">HeatmapOptions</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Minimap.html" title="map_gui::tools::Minimap struct">Minimap</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Navigator.html" title="map_gui::tools::Navigator struct">Navigator</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.PopupMsg.html" title="map_gui::tools::PopupMsg struct">PopupMsg</a></td><td class="docblock-short"><p>Display a message dialog.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PromptInput.html" title="map_gui::tools::PromptInput struct">PromptInput</a></td><td class="docblock-short"><p>Prompt for arbitrary text input, then feed the answer to a callback.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunCommand.html" title="map_gui::tools::RunCommand struct">RunCommand</a></td><td class="docblock-short"><p>Executes a command and displays STDOUT and STDERR in a loading screen window. Only works on
native, of course.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TurnExplorer.html" title="map_gui::tools::TurnExplorer struct">TurnExplorer</a></td><td class="docblock-short"><p>A tool to explore all of the turns from a single lane.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.URLManager.html" title="map_gui::tools::URLManager struct">URLManager</a></td><td class="docblock-short"><p>Utilities for reflecting the current map and viewport in the URL on the web. No effect on
native.</p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
<table><tr class="module-item"><td><a class="trait" href="trait.MinimapControls.html" title="map_gui::tools::MinimapControls trait">MinimapControls</a></td><td class="docblock-short"><p>Customize the appearance and behavior of a minimap.</p>
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<table><tr class="module-item"><td><a class="fn" href="fn.draw_isochrone.html" title="map_gui::tools::draw_isochrone fn">draw_isochrone</a></td><td class="docblock-short"><p>Thresholds are Durations, in units of seconds</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.find_exe.html" title="map_gui::tools::find_exe fn">find_exe</a></td><td class="docblock-short"><p>Returns the path to an executable. Native-only.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.goal_marker.html" title="map_gui::tools::goal_marker fn">goal_marker</a></td><td class="docblock-short"><p>Draw a goal marker pointing at something.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.grey_out_map.html" title="map_gui::tools::grey_out_map fn">grey_out_map</a></td><td class="docblock-short"><p>Make it clear the map can’t be interacted with right now.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.loading_tips.html" title="map_gui::tools::loading_tips fn">loading_tips</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.make_heatmap.html" title="map_gui::tools::make_heatmap fn">make_heatmap</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.nice_country_name.html" title="map_gui::tools::nice_country_name fn">nice_country_name</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.nice_map_name.html" title="map_gui::tools::nice_map_name fn">nice_map_name</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.open_browser.html" title="map_gui::tools::open_browser fn">open_browser</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.prompt_to_download_missing_data.html" title="map_gui::tools::prompt_to_download_missing_data fn">prompt_to_download_missing_data</a></td><td class="docblock-short"><p>Prompt to download a missing city. On either success or failure (maybe the player choosing to
not download, maybe a network error), the new map isn’t automatically loaded or anything; up to
the caller to handle that.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.start_marker.html" title="map_gui::tools::start_marker fn">start_marker</a></td><td class="docblock-short"><p>Draw a start marker pointing at something.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="map_gui" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink