abstreet/rustdoc/map_gui/trait.AppLike.html
2021-10-03 21:39:12 +00:00

24 lines
20 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="An application wishing to use the tools in this crate has to implement this on the struct that implements `widgetry::SharedAppState`, so that the tools here can access the map. See `SimpleApp` for an example implementation."><meta name="keywords" content="rust, rustlang, rust-lang, AppLike"><title>AppLike in map_gui - 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 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 AppLike</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.cs">cs</a><a href="#tymethod.draw_map">draw_map</a><a href="#tymethod.draw_with_opts">draw_with_opts</a><a href="#tymethod.make_warper">make_warper</a><a href="#tymethod.map">map</a><a href="#tymethod.map_switched">map_switched</a><a href="#tymethod.mut_cs">mut_cs</a><a href="#tymethod.mut_draw_map">mut_draw_map</a><a href="#tymethod.mut_opts">mut_opts</a><a href="#tymethod.opts">opts</a><a href="#tymethod.sim">sim</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.change_color_scheme">change_color_scheme</a><a href="#method.current_stage_and_remaining_time">current_stage_and_remaining_time</a><a href="#method.sim_time">sim_time</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></h2><div id="sidebar-vars" data-name="AppLike" 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" 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 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 class="trait" href="#">AppLike</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/lib.rs.html#34-79" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait AppLike {
<details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 14 methods</span></summary> fn <a href="#tymethod.map" class="fnname">map</a>(&amp;self) -&gt; &amp;<a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.sim" class="fnname">sim</a>(&amp;self) -&gt; &amp;<a class="struct" href="../sim/sim/struct.Sim.html" title="struct sim::sim::Sim">Sim</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.cs" class="fnname">cs</a>(&amp;self) -&gt; &amp;<a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.mut_cs" class="fnname">mut_cs</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.draw_map" class="fnname">draw_map</a>(&amp;self) -&gt; &amp;<a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.mut_draw_map" class="fnname">mut_draw_map</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.opts" class="fnname">opts</a>(&amp;self) -&gt; &amp;<a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.mut_opts" class="fnname">mut_opts</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.map_switched" class="fnname">map_switched</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;map: <a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;timer: &amp;mut <a class="struct" href="../abstutil/time/struct.Timer.html" title="struct abstutil::time::Timer">Timer</a>&lt;'_&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;);
<div class="item-spacer"></div> fn <a href="#tymethod.draw_with_opts" class="fnname">draw_with_opts</a>(&amp;self, g: &amp;mut GfxCtx&lt;'_&gt;, opts: <a class="struct" href="render/struct.DrawOptions.html" title="struct map_gui::render::DrawOptions">DrawOptions</a>);
<div class="item-spacer"></div> fn <a href="#tymethod.make_warper" class="fnname">make_warper</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pt: <a class="struct" href="../geom/pt/struct.Pt2D.html" title="struct geom::pt::Pt2D">Pt2D</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;target_cam_zoom: <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.f64.html">f64</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id: <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.ID.html" title="enum map_gui::ID">ID</a>&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.55.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn State&lt;Self&gt;&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
fn <a href="#method.sim_time" class="fnname">sim_time</a>(&amp;self) -&gt; <a class="struct" href="../geom/time/struct.Time.html" title="struct geom::time::Time">Time</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.current_stage_and_remaining_time" class="fnname">current_stage_and_remaining_time</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id: <a class="struct" href="../map_model/objects/intersection/struct.IntersectionID.html" title="struct map_model::objects::intersection::IntersectionID">IntersectionID</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.usize.html">usize</a>, <a class="struct" href="../geom/duration/struct.Duration.html" title="struct geom::duration::Duration">Duration</a><a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.tuple.html">)</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.change_color_scheme" class="fnname">change_color_scheme</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cs: <a class="enum" href="colors/enum.ColorSchemeChoice.html" title="enum map_gui::colors::ColorSchemeChoice">ColorSchemeChoice</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.bool.html">bool</a> { ... }
</details>}</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An application wishing to use the tools in this crate has to implement this on the struct that
implements <code>widgetry::SharedAppState</code>, so that the tools here can access the map. See
<code>SimpleApp</code> for an example implementation.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.map" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#35" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.map" class="fnname">map</a>(&amp;self) -&gt; &amp;<a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a></h4></div><div id="tymethod.sim" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#36" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.sim" class="fnname">sim</a>(&amp;self) -&gt; &amp;<a class="struct" href="../sim/sim/struct.Sim.html" title="struct sim::sim::Sim">Sim</a></h4></div><div id="tymethod.cs" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#37" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.cs" class="fnname">cs</a>(&amp;self) -&gt; &amp;<a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a></h4></div><div id="tymethod.mut_cs" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#38" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.mut_cs" class="fnname">mut_cs</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a></h4></div><div id="tymethod.draw_map" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#39" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.draw_map" class="fnname">draw_map</a>(&amp;self) -&gt; &amp;<a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a></h4></div><div id="tymethod.mut_draw_map" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#40" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.mut_draw_map" class="fnname">mut_draw_map</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a></h4></div><div id="tymethod.opts" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#41" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.opts" class="fnname">opts</a>(&amp;self) -&gt; &amp;<a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a></h4></div><div id="tymethod.mut_opts" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#42" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.mut_opts" class="fnname">mut_opts</a>(&amp;mut self) -&gt; &amp;mut <a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a></h4></div><div id="tymethod.map_switched" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#43" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.map_switched" class="fnname">map_switched</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;map: <a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;timer: &amp;mut <a class="struct" href="../abstutil/time/struct.Timer.html" title="struct abstutil::time::Timer">Timer</a>&lt;'_&gt;<br>)</h4></div><div id="tymethod.draw_with_opts" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#44" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.draw_with_opts" class="fnname">draw_with_opts</a>(&amp;self, g: &amp;mut GfxCtx&lt;'_&gt;, opts: <a class="struct" href="render/struct.DrawOptions.html" title="struct map_gui::render::DrawOptions">DrawOptions</a>)</h4></div><details class="rustdoc-toggle" open><summary><div id="tymethod.make_warper" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#46-54" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.make_warper" class="fnname">make_warper</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;pt: <a class="struct" href="../geom/pt/struct.Pt2D.html" title="struct geom::pt::Pt2D">Pt2D</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;target_cam_zoom: <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.f64.html">f64</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;id: <a class="enum" href="https://doc.rust-lang.org/1.55.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.ID.html" title="enum map_gui::ID">ID</a>&gt;<br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.55.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn State&lt;Self&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/1.55.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></h4></div></summary><div class="docblock"><p>Create a <code>widgetry::State</code> that warps to the given point.</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"><div id="method.sim_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#58-60" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.sim_time" class="fnname">sim_time</a>(&amp;self) -&gt; <a class="struct" href="../geom/time/struct.Time.html" title="struct geom::time::Time">Time</a></h4></div><div id="method.current_stage_and_remaining_time" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#61-63" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.current_stage_and_remaining_time" class="fnname">current_stage_and_remaining_time</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;id: <a class="struct" href="../map_model/objects/intersection/struct.IntersectionID.html" title="struct map_model::objects::intersection::IntersectionID">IntersectionID</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.usize.html">usize</a>, <a class="struct" href="../geom/duration/struct.Duration.html" title="struct geom::duration::Duration">Duration</a><a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.tuple.html">)</a></h4></div><details class="rustdoc-toggle" open><summary><div id="method.change_color_scheme" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/lib.rs.html#66-78" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.change_color_scheme" class="fnname">change_color_scheme</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut EventCtx&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;cs: <a class="enum" href="colors/enum.ColorSchemeChoice.html" title="enum map_gui::colors::ColorSchemeChoice">ColorSchemeChoice</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.55.0/std/primitive.bool.html">bool</a></h4></div></summary><div class="docblock"><p>Change the color scheme. Idempotent. Return true if there was a change.</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 id="impl-AppLike" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../src/map_gui/simple_app.rs.html#216-292" title="goto source code">[src]</a></div><a href="#impl-AppLike" class="anchor"></a><h3 class="code-header in-band">impl&lt;T:&nbsp;'static&gt; <a class="trait" href="trait.AppLike.html" title="trait map_gui::AppLike">AppLike</a> for <a class="struct" href="simple_app/struct.SimpleApp.html" title="struct map_gui::simple_app::SimpleApp">SimpleApp</a>&lt;T&gt;</h3></div></div><script type="text/javascript" src="../implementors/map_gui/trait.AppLike.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>
<script src="../main.js"></script>
</body></html>