mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-11-27 15:03:20 +03:00
30 lines
20 KiB
HTML
30 lines
20 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="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="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../map_gui/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"></h2>
|
||
</nav>
|
||
<nav class="sidebar"><a class="sidebar-logo" href="../map_gui/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"><a href="#">AppLike</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.cs">cs</a></li><li><a href="#tymethod.draw_map">draw_map</a></li><li><a href="#tymethod.draw_with_opts">draw_with_opts</a></li><li><a href="#tymethod.make_warper">make_warper</a></li><li><a href="#tymethod.map">map</a></li><li><a href="#tymethod.map_switched">map_switched</a></li><li><a href="#tymethod.mut_cs">mut_cs</a></li><li><a href="#tymethod.mut_draw_map">mut_draw_map</a></li><li><a href="#tymethod.mut_opts">mut_opts</a></li><li><a href="#tymethod.opts">opts</a></li><li><a href="#tymethod.sim">sim</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.change_color_scheme">change_color_scheme</a></li><li><a href="#method.current_stage_and_remaining_time">current_stage_and_remaining_time</a></li><li><a href="#method.sim_time">sim_time</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In map_gui</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../map_gui/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1">
|
||
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
|
||
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
|
||
<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 item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/map_gui/lib.rs.html#36-81">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>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>(&self) -> &<a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.sim" class="fnname">sim</a>(&self) -> &<a class="struct" href="../sim/sim/struct.Sim.html" title="struct sim::sim::Sim">Sim</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.cs" class="fnname">cs</a>(&self) -> &<a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.mut_cs" class="fnname">mut_cs</a>(&mut self) -> &mut <a class="struct" href="colors/struct.ColorScheme.html" title="struct map_gui::colors::ColorScheme">ColorScheme</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.draw_map" class="fnname">draw_map</a>(&self) -> &<a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.mut_draw_map" class="fnname">mut_draw_map</a>(&mut self) -> &mut <a class="struct" href="render/map/struct.DrawMap.html" title="struct map_gui::render::map::DrawMap">DrawMap</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.opts" class="fnname">opts</a>(&self) -> &<a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.mut_opts" class="fnname">mut_opts</a>(&mut self) -> &mut <a class="struct" href="options/struct.Options.html" title="struct map_gui::options::Options">Options</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.map_switched" class="fnname">map_switched</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> map: <a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>, <br> timer: &mut <a class="struct" href="../abstutil/time/struct.Timer.html" title="struct abstutil::time::Timer">Timer</a><'_><br> );
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.draw_with_opts" class="fnname">draw_with_opts</a>(&self, g: &mut GfxCtx<'_>, opts: <a class="struct" href="render/struct.DrawOptions.html" title="struct map_gui::render::DrawOptions">DrawOptions</a>);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.make_warper" class="fnname">make_warper</a>(<br> &mut self, <br> ctx: &EventCtx<'_>, <br> pt: <a class="struct" href="../geom/pt/struct.Pt2D.html" title="struct geom::pt::Pt2D">Pt2D</a>, <br> target_cam_zoom: <a class="enum" href="https://doc.rust-lang.org/1.63.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.63.0/std/primitive.f64.html">f64</a>>, <br> id: <a class="enum" href="https://doc.rust-lang.org/1.63.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ID.html" title="enum map_gui::ID">ID</a>><br> ) -> <a class="struct" href="https://doc.rust-lang.org/1.63.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn State<Self>><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/1.63.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>(&self) -> <a class="struct" href="../geom/time/struct.Time.html" title="struct geom::time::Time">Time</a> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.current_stage_and_remaining_time" class="fnname">current_stage_and_remaining_time</a>(<br> &self, <br> id: <a class="struct" href="../map_model/objects/intersection/struct.IntersectionID.html" title="struct map_model::objects::intersection::IntersectionID">IntersectionID</a><br> ) -> (<a class="primitive" href="https://doc.rust-lang.org/1.63.0/std/primitive.usize.html">usize</a>, <a class="struct" href="../geom/duration/struct.Duration.html" title="struct geom::duration::Duration">Duration</a>) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.change_color_scheme" class="fnname">change_color_scheme</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> cs: <a class="enum" href="colors/enum.ColorSchemeChoice.html" title="enum map_gui::colors::ColorSchemeChoice">ColorSchemeChoice</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/1.63.0/std/primitive.bool.html">bool</a> { ... }
|
||
</details>}</code></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#37">source</a></div><h4 class="code-header">fn <a href="#tymethod.map" class="fnname">map</a>(&self) -> &<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#38">source</a></div><h4 class="code-header">fn <a href="#tymethod.sim" class="fnname">sim</a>(&self) -> &<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#39">source</a></div><h4 class="code-header">fn <a href="#tymethod.cs" class="fnname">cs</a>(&self) -> &<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#40">source</a></div><h4 class="code-header">fn <a href="#tymethod.mut_cs" class="fnname">mut_cs</a>(&mut self) -> &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#41">source</a></div><h4 class="code-header">fn <a href="#tymethod.draw_map" class="fnname">draw_map</a>(&self) -> &<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#42">source</a></div><h4 class="code-header">fn <a href="#tymethod.mut_draw_map" class="fnname">mut_draw_map</a>(&mut self) -> &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#43">source</a></div><h4 class="code-header">fn <a href="#tymethod.opts" class="fnname">opts</a>(&self) -> &<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#44">source</a></div><h4 class="code-header">fn <a href="#tymethod.mut_opts" class="fnname">mut_opts</a>(&mut self) -> &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#45">source</a></div><h4 class="code-header">fn <a href="#tymethod.map_switched" class="fnname">map_switched</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> map: <a class="struct" href="../map_model/struct.Map.html" title="struct map_model::Map">Map</a>, <br> timer: &mut <a class="struct" href="../abstutil/time/struct.Timer.html" title="struct abstutil::time::Timer">Timer</a><'_><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#46">source</a></div><h4 class="code-header">fn <a href="#tymethod.draw_with_opts" class="fnname">draw_with_opts</a>(&self, g: &mut GfxCtx<'_>, 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#48-56">source</a></div><h4 class="code-header">fn <a href="#tymethod.make_warper" class="fnname">make_warper</a>(<br> &mut self, <br> ctx: &EventCtx<'_>, <br> pt: <a class="struct" href="../geom/pt/struct.Pt2D.html" title="struct geom::pt::Pt2D">Pt2D</a>, <br> target_cam_zoom: <a class="enum" href="https://doc.rust-lang.org/1.63.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.63.0/std/primitive.f64.html">f64</a>>, <br> id: <a class="enum" href="https://doc.rust-lang.org/1.63.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="enum.ID.html" title="enum map_gui::ID">ID</a>><br>) -> <a class="struct" href="https://doc.rust-lang.org/1.63.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn State<Self>> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/1.63.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </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#60-62">source</a></div><h4 class="code-header">fn <a href="#method.sim_time" class="fnname">sim_time</a>(&self) -> <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#63-65">source</a></div><h4 class="code-header">fn <a href="#method.current_stage_and_remaining_time" class="fnname">current_stage_and_remaining_time</a>(<br> &self, <br> id: <a class="struct" href="../map_model/objects/intersection/struct.IntersectionID.html" title="struct map_model::objects::intersection::IntersectionID">IntersectionID</a><br>) -> (<a class="primitive" href="https://doc.rust-lang.org/1.63.0/std/primitive.usize.html">usize</a>, <a class="struct" href="../geom/duration/struct.Duration.html" title="struct geom::duration::Duration">Duration</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#68-80">source</a></div><h4 class="code-header">fn <a href="#method.change_color_scheme" class="fnname">change_color_scheme</a>(<br> &mut self, <br> ctx: &mut EventCtx<'_>, <br> cs: <a class="enum" href="colors/enum.ColorSchemeChoice.html" title="enum map_gui::colors::ColorSchemeChoice">ColorSchemeChoice</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/1.63.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"><section id="impl-AppLike" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/map_gui/simple_app.rs.html#271-355">source</a></span><a href="#impl-AppLike" class="anchor"></a><h3 class="code-header in-band">impl<T: 'static> <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><T></h3></section></div><script type="text/javascript" src="../implementors/map_gui/trait.AppLike.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="map_gui" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0 (4b91a6ea7 2022-08-08)" ></div>
|
||
</body></html> |