abstreet/rustdoc/map_gui/tools/index.html

18 lines
9.6 KiB
HTML
Raw Normal View History

<!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="API documentation for the Rust `tools` mod in crate `map_gui`."><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><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 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../map_gui/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module tools</p><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><p class="location"><a href="../index.html">map_gui</a></p><script>window.sidebarCurrent = {name: "tools", ty: "mod", relpath: "../"};</script><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"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><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" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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-190" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../index.html">map_gui</a>::<wbr><a class="mod" href="">tools</a></span></h1><div class="docblock"><p>Assorted tools and UI states that're useful for applications built to display maps.</p>
</div><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="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="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></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.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.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.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></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.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></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "map_gui";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>