mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-26 07:52:05 +03:00
21 lines
13 KiB
HTML
21 lines
13 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 `SimpleState` trait in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, SimpleState"><title>widgetry::SimpleState - 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='../widgetry/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait SimpleState</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.on_click">on_click</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.draw">draw</a><a href="#method.draw_baselayer">draw_baselayer</a><a href="#method.on_mouseover">on_mouseover</a><a href="#method.other_event">other_event</a><a href="#method.panel_changed">panel_changed</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">widgetry</a></p><script>window.sidebarCurrent = {name: "SimpleState", ty: "trait", 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><span class="help-button">?</span>
|
||
<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">−</span>]</a></span><a class="srclink" href="../src/widgetry/app_state.rs.html#203-229" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">widgetry</a>::<wbr><a class="trait" href="">SimpleState</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait SimpleState<A> {
|
||
fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> action: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> panel: &<a class="struct" href="../widgetry/struct.Panel.html" title="struct widgetry::Panel">Panel</a><br> ) -> <a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A>;
|
||
|
||
fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br> &mut self, <br> _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &<a class="struct" href="../widgetry/struct.Panel.html" title="struct widgetry::Panel">Panel</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&mut self, _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A) { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.other_event" class="fnname">other_event</a>(&mut self, _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A) -> <a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.draw" class="fnname">draw</a>(&self, _: &mut <a class="struct" href="../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>, _: <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.draw_baselayer" class="fnname">draw_baselayer</a>(&self) -> <a class="enum" href="../widgetry/enum.DrawBaselayer.html" title="enum widgetry::DrawBaselayer">DrawBaselayer</a> { ... }
|
||
}</pre></div><div class="docblock"><p>Many states fit a pattern of managing a single panel, handling mouseover events, and other
|
||
interactions on the map. Implementing this instead of <code>State</code> reduces some boilerplate.</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.on_click" class="method"><code>fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> action: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> panel: &<a class="struct" href="../widgetry/struct.Panel.html" title="struct widgetry::Panel">Panel</a><br>) -> <a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A></code></h3><div class="docblock"><p>Called when something on the panel has been clicked. Since the action is just a string,
|
||
the fallback case can just use <code>unreachable!()</code>.</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.panel_changed" class="method"><code>fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br> &mut self, <br> _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &<a class="struct" href="../widgetry/struct.Panel.html" title="struct widgetry::Panel">Panel</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A>></code></h3><div class="docblock"><p>Called when something on the panel has changed. If a transition is returned, stop handling
|
||
the event and immediately apply the transition.</p>
|
||
</div><h3 id="method.on_mouseover" class="method"><code>fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&mut self, _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A)</code></h3><div class="docblock"><p>Called when the mouse has moved.</p>
|
||
</div><h3 id="method.other_event" class="method"><code>fn <a href="#method.other_event" class="fnname">other_event</a>(&mut self, _: &mut <a class="struct" href="../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A) -> <a class="enum" href="../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A></code></h3><div class="docblock"><p>If a panel <code>on_click</code> event didn't occur and <code>panel_changed</code> didn't return transition, then
|
||
call this to handle all other events.</p>
|
||
</div><h3 id="method.draw" class="method"><code>fn <a href="#method.draw" class="fnname">draw</a>(&self, _: &mut <a class="struct" href="../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A)</code></h3><h3 id="method.draw_baselayer" class="method"><code>fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&self) -> <a class="enum" href="../widgetry/enum.DrawBaselayer.html" title="enum widgetry::DrawBaselayer">DrawBaselayer</a></code></h3></div><span class="loading-content">Loading content...</span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<A: 'static> dyn <a class="trait" href="../widgetry/app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a><A></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/widgetry/app_state.rs.html#231-235" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(panel: <a class="struct" href="../widgetry/struct.Panel.html" title="struct widgetry::Panel">Panel</a>, inner: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="../widgetry/app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a><A>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="../widgetry/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>></code><a class="srclink" href="../src/widgetry/app_state.rs.html#232-234" title="goto source code">[src]</a></h4></div><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/widgetry/trait.SimpleState.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "widgetry";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |