1
1
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-24 06:55:40 +03:00
abstreet/rustdoc/map_gui/tools/trait.MinimapControls.html
2022-01-13 18:04:25 +00:00

25 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="Customize the appearance and behavior of a minimap."><meta name="keywords" content="rust, rustlang, rust-lang, MinimapControls"><title>MinimapControls in 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><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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">Trait MinimapControls</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.has_zorder">has_zorder</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.draw_extra">draw_extra</a><a href="#method.has_layer">has_layer</a><a href="#method.make_legend">make_legend</a><a href="#method.make_unzoomed_panel">make_unzoomed_panel</a><a href="#method.make_zoomed_side_panel">make_zoomed_side_panel</a><a href="#method.panel_changed">panel_changed</a><a href="#method.panel_clicked">panel_clicked</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">map_gui</a>::<wbr><a href="index.html">tools</a></h2><div id="sidebar-vars" data-name="MinimapControls" data-ty="trait" 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 width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></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" 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 width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="../index.html">map_gui</a>::<wbr><a href="index.html">tools</a>::<wbr><a class="trait" href="#">MinimapControls</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></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/minimap.rs.html#35-68" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait MinimapControls&lt;A:&nbsp;<a class="trait" href="../trait.AppLike.html" title="trait map_gui::AppLike">AppLike</a>&gt; {
fn <a href="#tymethod.has_zorder" class="fnname">has_zorder</a>(&amp;self, app: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.bool.html">bool</a>;
fn <a href="#method.has_layer" class="fnname">has_layer</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.draw_extra" class="fnname">draw_extra</a>(&amp;self, _: &amp;mut GfxCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) { ... }
<div class="item-spacer"></div> fn <a href="#method.make_unzoomed_panel" class="fnname">make_unzoomed_panel</a>(&amp;self, ctx: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Panel { ... }
<div class="item-spacer"></div> fn <a href="#method.make_legend" class="fnname">make_legend</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Widget { ... }
<div class="item-spacer"></div> fn <a href="#method.make_zoomed_side_panel" class="fnname">make_zoomed_side_panel</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Widget { ... }
<div class="item-spacer"></div> fn <a href="#method.panel_clicked" class="fnname">panel_clicked</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.str.html">str</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.58.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Transition&lt;A&gt;&gt; { ... }
<div class="item-spacer"></div> fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;mut </a>A, _: &amp;Panel) { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Customize the appearance and behavior of a minimap.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.has_zorder" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#38" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.has_zorder" class="fnname">has_zorder</a>(&amp;self, app: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Should the user be able to control the z-order visible? The control is only present when
zoomed in, placed beneath the zoom column.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.has_layer" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#41-43" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.has_layer" class="fnname">has_layer</a>(&amp;self, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Is there some additional layer displayed on the minimap? If this changes, the panel gets
recalculated.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.draw_extra" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#46" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.draw_extra" class="fnname">draw_extra</a>(&amp;self, _: &amp;mut GfxCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A)</h4></div></summary><div class="docblock"><p>Draw extra stuff on the minimap, just pulling from the app.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.make_unzoomed_panel" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#49-51" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.make_unzoomed_panel" class="fnname">make_unzoomed_panel</a>(&amp;self, ctx: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Panel</h4></div></summary><div class="docblock"><p>When unzoomed, display this panel. By default, no controls when unzoomed.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.make_legend" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#54-56" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.make_legend" class="fnname">make_legend</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Widget</h4></div></summary><div class="docblock"><p>A row beneath the minimap in the zoomed view, usually used as a legend for things on the
minimap.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.make_zoomed_side_panel" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#58-60" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.make_zoomed_side_panel" class="fnname">make_zoomed_side_panel</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;</a>A) -&gt; Widget</h4></div></summary><div class="docblock"><p>Controls to be placed to the left to the zoomed-in panel</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.panel_clicked" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#63-65" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.panel_clicked" class="fnname">panel_clicked</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.str.html">str</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.58.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Transition&lt;A&gt;&gt;</h4></div></summary><div class="docblock"><p>If a button is clicked that was produced by some method in this trait, respond to it here.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.panel_changed" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/map_gui/tools/minimap.rs.html#67" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(&amp;self, _: &amp;mut EventCtx&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.58.0/std/primitive.reference.html">&amp;mut </a>A, _: &amp;Panel)</h4></div></summary><div class="docblock"><p>Called for <code>Outcome::Changed</code> on the panel.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../implementors/map_gui/tools/trait.MinimapControls.js" async></script></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>
</body></html>