mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-11-27 15:03:20 +03:00
20 lines
18 KiB
HTML
20 lines
18 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="Many states fit a pattern of managing a single panel, handling mouseover events, and other interactions on the map. Implementing this instead of `State` reduces some boilerplate."><meta name="keywords" content="rust, rustlang, rust-lang, SimpleState"><title>SimpleState in widgetry - 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="../widgetry/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="../widgetry/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SimpleState</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.on_click">on_click</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.draw">draw</a></li><li><a href="#method.draw_baselayer">draw_baselayer</a></li><li><a href="#method.on_click_custom">on_click_custom</a></li><li><a href="#method.on_mouseover">on_mouseover</a></li><li><a href="#method.other_event">other_event</a></li><li><a href="#method.panel_changed">panel_changed</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.new_state">new_state</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 widgetry</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../widgetry/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"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><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">widgetry</a>::<wbr><a class="trait" href="#">SimpleState</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/widgetry/app_state.rs.html#234-275">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 SimpleState<A> {
|
||
fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br> &mut self,<br> ctx: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> app: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> action: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>,<br> panel: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br> ) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A>;
|
||
|
||
fn <a href="#method.on_click_custom" class="fnname">on_click_custom</a>(<br> &mut self,<br> _ctx: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> _app: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> _action: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="../abstutil/clone/trait.CloneableAny.html" title="trait abstutil::clone::CloneableAny">CloneableAny</a>>,<br> _panel: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br> ) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br> &mut self,<br> _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> _: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br> ) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&mut self, _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.other_event" class="fnname">other_event</a>(&mut self, _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.draw" class="fnname">draw</a>(&self, _: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>A) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&self) -> <a class="enum" href="app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></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.on_click" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#237-243">source</a></div><h4 class="code-header">fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br> &mut self,<br> ctx: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> app: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> action: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>,<br> panel: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A></h4></div></summary><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></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.on_click_custom" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#245-253">source</a></div><h4 class="code-header">fn <a href="#method.on_click_custom" class="fnname">on_click_custom</a>(<br> &mut self,<br> _ctx: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> _app: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> _action: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="../abstutil/clone/trait.CloneableAny.html" title="trait abstutil::clone::CloneableAny">CloneableAny</a>>,<br> _panel: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A></h4></div></summary><div class="docblock"><p>Called when something on the panel has been clicked.</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/widgetry/app_state.rs.html#256-263">source</a></div><h4 class="code-header">fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br> &mut self,<br> _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>,<br> _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A,<br> _: &mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A>></h4></div></summary><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></details><details class="rustdoc-toggle" open><summary><div id="method.on_mouseover" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#265">source</a></div><h4 class="code-header">fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&mut self, _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A)</h4></div></summary><div class="docblock"><p>Called when the mouse has moved.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.other_event" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#268-270">source</a></div><h4 class="code-header">fn <a href="#method.other_event" class="fnname">other_event</a>(&mut self, _: &mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>A) -> <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a><A></h4></div></summary><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></details><div id="method.draw" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#271">source</a></div><h4 class="code-header">fn <a href="#method.draw" class="fnname">draw</a>(&self, _: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>, _: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>A)</h4></div><div id="method.draw_baselayer" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#272-274">source</a></div><h4 class="code-header">fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&self) -> <a class="enum" href="app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a></h4></div></div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-dyn%20SimpleState%3CA%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#277-281">source</a></span><a href="#impl-dyn%20SimpleState%3CA%3E" class="anchor"></a><h3 class="code-header in-band">impl<A: 'static> dyn <a class="trait" href="app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a><A></h3></section></summary><div class="impl-items"><section id="method.new_state" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#278-280">source</a></span><h4 class="code-header">pub fn <a href="#method.new_state" class="fnname">new_state</a>(<br> panel: <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a>,<br> inner: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a><A>><br>) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>></h4></section></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/widgetry/app_state/trait.SimpleState.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="widgetry" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |