mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-27 00:12:55 +03:00
20 lines
7.1 KiB
HTML
20 lines
7.1 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 widgetry application splits its state into two pieces: global shared state that lasts for the entire lifetime of the application, and a stack of smaller states, only one of which is active at a time. For example, imagine an application to view a map. The shared state would include the map and pre-rendered geometry for it. The individual states might start with a splash screen or menu to choose a map, then a map viewer, then maybe a state to drill down into pieces of the map."><meta name="keywords" content="rust, rustlang, rust-lang, app_state"><title>widgetry::app_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><script src="../../crates.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"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../widgetry/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module app_state</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><div id="sidebar-vars" data-name="app_state" data-ty="mod" data-relpath="./"></div><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" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">widgetry</a>::<wbr><a class="mod" href="#">app_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><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#1-299" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A widgetry application splits its state into two pieces: global shared state that lasts for the
|
||
entire lifetime of the application, and a stack of smaller states, only one of which is active
|
||
at a time. For example, imagine an application to view a map. The shared state would include
|
||
the map and pre-rendered geometry for it. The individual states might start with a splash
|
||
screen or menu to choose a map, then a map viewer, then maybe a state to drill down into pieces
|
||
of the map.</p>
|
||
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.App.html" title="widgetry::app_state::App struct">App</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SimpleStateWrapper.html" title="widgetry::app_state::SimpleStateWrapper struct">SimpleStateWrapper</a></div><div class="item-right docblock-short"></div></div></div><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DrawBaselayer.html" title="widgetry::app_state::DrawBaselayer enum">DrawBaselayer</a></div><div class="item-right docblock-short"><p>Before <code>State::draw</code> is called, draw something else.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Transition.html" title="widgetry::app_state::Transition enum">Transition</a></div><div class="item-right docblock-short"><p>When a state responds to an event, it can specify some way to manipulate the stack of states.</p>
|
||
</div></div></div><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SharedAppState.html" title="widgetry::app_state::SharedAppState trait">SharedAppState</a></div><div class="item-right docblock-short"><p>Any data that should last the entire lifetime of the application should be stored in the struct
|
||
implementing this trait.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SimpleState.html" title="widgetry::app_state::SimpleState trait">SimpleState</a></div><div class="item-right docblock-short"><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></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.State.html" title="widgetry::app_state::State trait">State</a></div><div class="item-right docblock-short"><p>A temporary state of an application. There’s a stack of these, with the most recent being the
|
||
active one.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="widgetry" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
|
||
<script src="../../main.js"></script>
|
||
</body></html> |