mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-18 20:02:18 +03:00
27 lines
12 KiB
HTML
27 lines
12 KiB
HTML
<!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 `MinimapControls` trait in crate `map_gui`."><meta name="keywords" content="rust, rustlang, rust-lang, MinimapControls"><title>map_gui::tools::minimap::MinimapControls - 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 trait"><!--[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">☰</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">Trait MinimapControls</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.has_zorder">has_zorder</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.make_legend">make_legend</a><a href="#method.has_layer">has_layer</a><a href="#method.draw_extra">draw_extra</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_clicked">panel_clicked</a><a href="#method.panel_changed">panel_changed</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../index.html">map_gui</a>::<wbr><a href="../index.html">tools</a>::<wbr><a href="index.html">minimap</a></p><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"><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="in-band">Trait <a href="../../index.html">map_gui</a>::<wbr><a href="../index.html">tools</a>::<wbr><a href="index.html">minimap</a>::<wbr><a class="trait" href="">MinimapControls</a></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">−</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 type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait MinimapControls<A: <a class="trait" href="../../../map_gui/trait.AppLike.html" title="trait map_gui::AppLike">AppLike</a>> {
|
||
fn <a href="#tymethod.has_zorder" class="fnname">has_zorder</a>(&self, app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
|
||
fn <a href="#method.has_layer" class="fnname">has_layer</a>(&self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.draw_extra" class="fnname">draw_extra</a>(&self, _: &mut GfxCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.make_unzoomed_panel" class="fnname">make_unzoomed_panel</a>(&self, ctx: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Panel { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.make_legend" class="fnname">make_legend</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Widget { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.make_zoomed_side_panel" class="fnname">make_zoomed_side_panel</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Widget { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.panel_clicked" class="fnname">panel_clicked</a>(<br> &self, <br> _: &mut EventCtx<'_>, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Transition<A>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, _: &Panel) { ... }
|
||
}</pre></div><div class="docblock"><p>Customize the appearance and behavior of a minimap.</p>
|
||
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.has_zorder" class="method"><code>fn <a href="#tymethod.has_zorder" class="fnname">has_zorder</a>(&self, app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#38" title="goto source code">[src]</a></h3><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></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.has_layer" class="method"><code>fn <a href="#method.has_layer" class="fnname">has_layer</a>(&self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#41-43" title="goto source code">[src]</a></h3><div class="docblock"><p>Is there some additional layer displayed on the minimap? If this changes, the panel gets
|
||
recalculated.</p>
|
||
</div><h3 id="method.draw_extra" class="method"><code>fn <a href="#method.draw_extra" class="fnname">draw_extra</a>(&self, _: &mut GfxCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A)</code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#46" title="goto source code">[src]</a></h3><div class="docblock"><p>Draw extra stuff on the minimap, just pulling from the app.</p>
|
||
</div><h3 id="method.make_unzoomed_panel" class="method"><code>fn <a href="#method.make_unzoomed_panel" class="fnname">make_unzoomed_panel</a>(&self, ctx: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Panel</code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#49-51" title="goto source code">[src]</a></h3><div class="docblock"><p>When unzoomed, display this panel. By default, no controls when unzoomed.</p>
|
||
</div><h3 id="method.make_legend" class="method"><code>fn <a href="#method.make_legend" class="fnname">make_legend</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Widget</code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#54-56" title="goto source code">[src]</a></h3><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><h3 id="method.make_zoomed_side_panel" class="method"><code>fn <a href="#method.make_zoomed_side_panel" class="fnname">make_zoomed_side_panel</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A) -> Widget</code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#58-60" title="goto source code">[src]</a></h3><div class="docblock"><p>Controls to be placed to the left to the zoomed-in panel</p>
|
||
</div><h3 id="method.panel_clicked" class="method"><code>fn <a href="#method.panel_clicked" class="fnname">panel_clicked</a>(<br> &self, <br> _: &mut EventCtx<'_>, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Transition<A>></code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#63-65" title="goto source code">[src]</a></h3><div class="docblock"><p>If a button is clicked that was produced by some method in this trait, respond to it here.</p>
|
||
</div><h3 id="method.panel_changed" class="method"><code>fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(&self, _: &mut EventCtx<'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, _: &Panel)</code><a class="srclink" href="../../../src/map_gui/tools/minimap.rs.html#67" title="goto source code">[src]</a></h3><div class="docblock"><p>Called for <code>Outcome::Changed</code> on the panel.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/map_gui/tools/minimap/trait.MinimapControls.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="map_gui"></div>
|
||
<script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |