mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-27 00:12:55 +03:00
25 lines
15 KiB
HTML
25 lines
15 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 `State` trait in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, State"><title>widgetry::app_state::State - 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 State</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.draw">draw</a><a href="#tymethod.event">event</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.draw_baselayer">draw_baselayer</a><a href="#method.on_destroy">on_destroy</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.downcast">downcast</a><a href="#method.downcast_mut">downcast_mut</a><a href="#method.downcast_rc">downcast_rc</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.is">is</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">widgetry</a>::<wbr><a href="index.html">app_state</a></p><script>window.sidebarCurrent = {name: "State", 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#165-179" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">widgetry</a>::<wbr><a href="index.html">app_state</a>::<wbr><a class="trait" href="">State</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait State<A>: Downcast {
|
||
fn <a href="#tymethod.event" class="fnname">event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A<br> ) -> <a class="enum" href="../../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A>;
|
||
<div class="item-spacer"></div> fn <a href="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut <a class="struct" href="../../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>, shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A);
|
||
|
||
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> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.on_destroy" class="fnname">on_destroy</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) { ... }
|
||
}</pre></div><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><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.event" class="method"><code>fn <a href="#tymethod.event" class="fnname">event</a>(<br> &mut self, <br> ctx: &mut <a class="struct" href="../../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, <br> shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A<br>) -> <a class="enum" href="../../widgetry/enum.Transition.html" title="enum widgetry::Transition">Transition</a><A></code></h3><div class="docblock"><p>Respond to a UI event, such as input or time passing.</p>
|
||
</div><h3 id="tymethod.draw" class="method"><code>fn <a href="#tymethod.draw" class="fnname">draw</a>(&self, g: &mut <a class="struct" href="../../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>, shared_app_state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A)</code></h3><div class="docblock"><p>Draw</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.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 class="docblock"><p>Specifies what to draw before draw()</p>
|
||
</div><h3 id="method.on_destroy" class="method"><code>fn <a href="#method.on_destroy" class="fnname">on_destroy</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>Before this state is popped or replaced, call this.</p>
|
||
</div></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> dyn <a class="trait" href="../../widgetry/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/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, </span></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is" class="method"><code>pub fn <a href="#method.is" class="fnname">is</a><__T: <a class="trait" href="../../widgetry/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
|
||
</div><h4 id="method.downcast" class="method"><code>pub fn <a href="#method.downcast" class="fnname">downcast</a><__T: <a class="trait" href="../../widgetry/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><__T>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h4><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><h4 id="method.downcast_rc" class="method"><code>pub fn <a href="#method.downcast_rc" class="fnname">downcast_rc</a><__T: <a class="trait" href="../../widgetry/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><__T>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><Self>></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h4><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><h4 id="method.downcast_ref" class="method"><code>pub fn <a href="#method.downcast_ref" class="fnname">downcast_ref</a><__T: <a class="trait" href="../../widgetry/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a><A>>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>__T></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h4><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><h4 id="method.downcast_mut" class="method"><code>pub fn <a href="#method.downcast_mut" class="fnname">downcast_mut</a><__T: <a class="trait" href="../../widgetry/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/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__T></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#181" title="goto source code">[src]</a></h4><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></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-State%3CA%3E" class="impl"><code class="in-band">impl<A: 'static> State<A> for <a class="struct" href="../../widgetry/app_state/struct.SimpleStateWrapper.html" title="struct widgetry::app_state::SimpleStateWrapper">SimpleStateWrapper</a><A></code><a href="#impl-State%3CA%3E" class="anchor"></a><a class="srclink" href="../../src/widgetry/app_state.rs.html#251-274" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.event" class="method hidden"><code>fn <a href="#method.event" class="fnname">event</a>(&mut self, ctx: &mut <a class="struct" href="../../widgetry/struct.EventCtx.html" title="struct widgetry::EventCtx">EventCtx</a><'_>, app: <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><a class="srclink" href="../../src/widgetry/app_state.rs.html#252-264" title="goto source code">[src]</a></h4><h4 id="method.draw" class="method hidden"><code>fn <a href="#method.draw" class="fnname">draw</a>(&self, g: &mut <a class="struct" href="../../widgetry/struct.GfxCtx.html" title="struct widgetry::GfxCtx">GfxCtx</a><'_>, app: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>A)</code><a class="srclink" href="../../src/widgetry/app_state.rs.html#266-270" title="goto source code">[src]</a></h4><h4 id="method.draw_baselayer-1" class="method hidden"><code>fn <a href="#method.draw_baselayer-1" class="fnname">draw_baselayer</a>(&self) -> <a class="enum" href="../../widgetry/enum.DrawBaselayer.html" title="enum widgetry::DrawBaselayer">DrawBaselayer</a></code><a class="srclink" href="../../src/widgetry/app_state.rs.html#271-273" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../implementors/widgetry/app_state/trait.State.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> |