mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-20 04:42:16 +03:00
32 lines
20 KiB
HTML
32 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="A temporary state of an application. There’s a stack of these, with the most recent being the active one."><meta name="keywords" content="rust, rustlang, rust-lang, State"><title>State 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 src="../crates.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="#">State</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.draw">draw</a></li><li><a href="#tymethod.event">event</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_baselayer">draw_baselayer</a></li><li><a href="#method.on_destroy">on_destroy</a></li><li><a href="#method.recreate">recreate</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.downcast">downcast</a></li><li><a href="#method.downcast_mut">downcast_mut</a></li><li><a href="#method.downcast_rc">downcast_rc</a></li><li><a href="#method.downcast_ref">downcast_ref</a></li><li><a href="#method.is">is</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 id="sidebar-vars" data-name="State" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></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"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></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="#">State</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#178-198">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 State<A>: Downcast {
|
||
fn <a href="#tymethod.event" class="fnname">event</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> shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&mut </a>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="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>, shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&</a>A);
|
||
|
||
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> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_destroy" class="fnname">on_destroy</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.61.0/std/primitive.reference.html">&mut </a>A) { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.recreate" class="fnname">recreate</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.61.0/std/primitive.reference.html">&mut </a>A) -> <a class="struct" href="https://doc.rust-lang.org/1.61.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>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A temporary state of an application. There’s a stack of these, with the most recent being the
|
||
active one.</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.event" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#180">source</a></div><h4 class="code-header">fn <a href="#tymethod.event" class="fnname">event</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> shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&mut </a>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>Respond to a UI event, such as input or time passing.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.draw" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#182">source</a></div><h4 class="code-header">fn <a href="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>, shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&</a>A)</h4></div></summary><div class="docblock"><p>Draw</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.draw_baselayer" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#185-187">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></summary><div class="docblock"><p>Specifies what to draw before draw()</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.on_destroy" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#190">source</a></div><h4 class="code-header">fn <a href="#method.on_destroy" class="fnname">on_destroy</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.61.0/std/primitive.reference.html">&mut </a>A)</h4></div></summary><div class="docblock"><p>Before this state is popped or replaced, call this.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.recreate" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#195-197">source</a></div><h4 class="code-header">fn <a href="#method.recreate" class="fnname">recreate</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.61.0/std/primitive.reference.html">&mut </a>A) -> <a class="struct" href="https://doc.rust-lang.org/1.61.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></div></summary><div class="docblock"><p>Respond to <code>Transition::Recreate</code> by assuming state in the app has changed, but preserving
|
||
the <code>State</code>-specific state appropriately.</p>
|
||
</div></details></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" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#impl" class="anchor"></a><h3 class="code-header in-band">impl<A> dyn <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/1.61.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#method.is" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.is" class="fnname">is</a><__T: <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.downcast" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#method.downcast" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast" class="fnname">downcast</a><__T: <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(self: <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="enum" href="https://doc.rust-lang.org/1.61.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><__T>, <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Returns a boxed object from a boxed trait object if the underlying object is of type
|
||
<code>__T</code>. Returns the original boxed trait if it isn’t.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.downcast_rc" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#method.downcast_rc" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_rc" class="fnname">downcast_rc</a><__T: <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(self: <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>) -> <a class="enum" href="https://doc.rust-lang.org/1.61.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><__T>, <a class="struct" href="https://doc.rust-lang.org/1.61.0/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>></h4></section></summary><div class="docblock"><p>Returns an <code>Rc</code>-ed object from an <code>Rc</code>-ed trait object if the underlying object is of
|
||
type <code>__T</code>. Returns the original <code>Rc</code>-ed trait if it isn’t.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.downcast_ref" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#method.downcast_ref" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_ref" class="fnname">downcast_ref</a><__T: <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.61.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&</a>__T></h4></section></summary><div class="docblock"><p>Returns a reference to the object within the trait object if it is of type <code>__T</code>, or
|
||
<code>None</code> if it isn’t.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.downcast_mut" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#200">source</a></span><a href="#method.downcast_mut" class="anchor"></a><h4 class="code-header">pub fn <a href="#method.downcast_mut" class="fnname">downcast_mut</a><__T: <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.61.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.61.0/std/primitive.reference.html">&mut </a>__T></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the object within the trait object if it is of type
|
||
<code>__T</code>, or <code>None</code> if it isn’t.</p>
|
||
</div></details></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-State%3CA%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/tools/popup.rs.html#41-72">source</a></span><a href="#impl-State%3CA%3E" class="anchor"></a><h3 class="code-header in-band">impl<A> <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A> for <a class="struct" href="tools/popup/struct.PopupMsg.html" title="struct widgetry::tools::popup::PopupMsg">PopupMsg</a></h3></section><section id="impl-State%3CA%3E-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/tools/load.rs.html#377-459">source</a></span><a href="#impl-State%3CA%3E-1" class="anchor"></a><h3 class="code-header in-band">impl<A, T> <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A> for <a class="struct" href="tools/load/struct.FutureLoader.html" title="struct widgetry::tools::load::FutureLoader">FutureLoader</a><A, T> <span class="where fmt-newline">where<br> A: 'static,<br> T: 'static, </span></h3></section><section id="impl-State%3CA%3E-2" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/app_state.rs.html#288-316">source</a></span><a href="#impl-State%3CA%3E-2" class="anchor"></a><h3 class="code-header in-band">impl<A: 'static> <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A> for <a class="struct" href="app_state/struct.SimpleStateWrapper.html" title="struct widgetry::app_state::SimpleStateWrapper">SimpleStateWrapper</a><A></h3></section><section id="impl-State%3CA%3E-3" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/widgetry/tools/load.rs.html#60-72">source</a></span><a href="#impl-State%3CA%3E-3" class="anchor"></a><h3 class="code-header in-band">impl<A: 'static, T: 'static + <a class="trait" href="tools/load/native_loader/trait.Readable.html" title="trait widgetry::tools::load::native_loader::Readable">Readable</a>> <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A> for <a class="struct" href="tools/load/native_loader/struct.FileLoader.html" title="struct widgetry::tools::load::native_loader::FileLoader">FileLoader</a><A, T></h3></section></div><script type="text/javascript" src="../implementors/widgetry/trait.State.js" async></script></section><section id="search" class="content hidden"></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.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||
</body></html> |