<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="This provides a builder API for adding objects to a `World`."><metaname="keywords"content="rust, rustlang, rust-lang, ObjectBuilder"><title>ObjectBuilder in widgetry::mapspace::world - Rust</title><linkrel="stylesheet"type="text/css"href="../../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../../ayu.css"disabled><scriptid="default-settings"></script><scriptsrc="../../../storage.js"></script><scriptsrc="../../../crates.js"></script><noscript><linkrel="stylesheet"href="../../../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../../../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../../../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../../../favicon.svg"><styletype="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../../../widgetry/index.html'><divclass='logo-container rust-logo'><imgsrc='../../../rust-logo.png'alt='logo'></div></a><h2class="location">Struct ObjectBuilder</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.clickable">clickable</a><ahref="#structfield.draggable">draggable</a><ahref="#structfield.draw_hover">draw_hover</a><ahref="#structfield.draw_normal">draw_normal</a><ahref="#structfield.hitbox">hitbox</a><ahref="#structfield.id">id</a><ahref="#structfield.keybindings">keybindings</a><ahref="#structfield.tooltip">tooltip</a><ahref="#structfield.world">world</a><ahref="#structfield.zorder">zorder</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.build">build</a><ahref="#method.clickable">clickable</a><ahref="#method.draggable">draggable</a><ahref="#method.draw">draw</a><ahref="#method.draw_color">draw_color</a><ahref="#method.draw_hover_rewrite">draw_hover_rewrite</a><ahref="#method.draw_hovered">draw_hovered</a><ahref="#method.drawn_in_master_batch">drawn_in_master_batch</a><ahref="#method.hitbox">hitbox</a><ahref="#method.hotkey">hotkey</a><ahref="#method.hover_alpha">hover_alpha</a><ahref="#method.hover_outline">hover_outline</a><ahref="#method.tooltip">tooltip</a><ahref="#method.zorder">zorder</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">!RefUnwindSafe</a><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">!UnwindSafe</a></div><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-Downcast">Downcast</a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><h2class="location">Other items in<br><ahref="../../index.html">widgetry</a>::<wbr><ahref="../index.html">mapspace</a>::<wbr><ahref="index.html">world</a></h2><divid="sidebar-vars"data-name="ObjectBuilder"data-ty="struct"data-relpath=""></div
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>This provides a builder API for adding objects to a <code>World</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.zorder"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#105-109"title="goto source code">[src]</a></div><ahref="#method.zorder"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.zorder"class="fnname">zorder</a>(self, zorder: <aclass="primitive"href="https://doc.rust-lang.org/1.56.1/std/primitive.usize.html">usize</a>) -> Self</h4></div></summary><divclass="docblock"><p>Provides ordering for overlapping objects. Higher values are “on top” of lower values.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.draw"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#112-119"title="goto source code">[src]</a></div><ahref="#method.draw"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.draw"class="fnname">draw</a><I: <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="../struct.ToggleZoomedBuilder.html"title="struct widgetry::mapspace::ToggleZoomedBuilder">ToggleZoomedBuilder</a>>>(self, normal: I) -> Self</h4></div></summary><divclass="docblock"><p>Specifies how to draw this object normally (while not hovering on it)</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.draw_color"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#122-125"title="goto source code">[src]</a></div><ahref="#method.draw_color"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.draw_color"class="fnname">draw_color</a>(self, color: <aclass="struct"href="../../color/struct.Color.html"title="struct widgetry::color::Color">Color</a>) -> Self</h4></div></summary><divclass="docblock"><p>Draw the object by coloring its hitbox</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.drawn_in_master_batch"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#128-134"title="goto source code">[src]</a></div><ahref="#method.drawn_in_master_batch"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.drawn_in_master_batch"class="fnname">drawn_in_master_batch</a>(self) -> Self</h4></div></summary><divclass="docblock"><p>Indicate that an object doesn’t need to be drawn individually. A call to <code>draw_master_batch</code> covers it.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.draw_hovered"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#138-145"title="goto source code">[src]</a></div><ahref="#method.draw_hovered"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.draw_hovered"class="fnname">draw_hovered</a><I: <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="struct"href="../struct.ToggleZoomedBuilder.html"title="struct widgetry::mapspace::ToggleZoomedBuilder">ToggleZoomedBuilder</a>>>(self, hovered: I) -> Self</h4></div></summary><divclass="docblock"><p>Specifies how to draw the object while the cursor is hovering on it. Note that an object
isn’t considered hoverable unless this is specified!</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.draw_hover_rewrite"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#148-155"title="goto source code">[src]</a></div><ahref="#method.draw_hover_rewrite"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.draw_hover_rewrite"class="fnname">draw_hover_rewrite</a>(self, rewrite: <aclass="enum"href="../../geom/enum.RewriteColor.html"title="enum widgetry::geom::RewriteColor">RewriteColor</a>) -> Self</h4></div></summary><divclass="docblock"><p>Draw the object in a hovered state by transforming the normal drawing.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.hover_alpha"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#158-160"title="goto source code">[src]</a></div><ahref="#method.hover_alpha"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.hover_alpha"class="fnname">hover_alpha</a>(self, alpha: <aclass="primitive"href="https://doc.rust-lang.org/1.56.1/std/primitive.f32.html">f32</a>) -> Self</h4></div></summary><divclass="docblock"><p>Draw the object in a hovered state by changing the alpha value of the normal drawing.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.hover_outline"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#163-183"title="goto source code">[src]</a></div><ahref="#method.hover_outline"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.hover_outline"class="fnname">hover_outline</a>(self, color: <aclass="struct"href="../../color/struct.Color.html"title="struct widgetry::color::Color">Color</a>, thickness: <aclass="struct"href="../../../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a>) -> Self</h4></div></summary><divclass="docblock"><p>Draw the object in a hovered state by adding an outline to the normal drawing.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.tooltip"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#186-196"title="goto source code">[src]</a></div><ahref="#method.tooltip"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.tooltip"class="fnname">tooltip</a>(self, txt: <aclass="struct"href="../../text/struct.Text.html"title="struct widgetry::text::Text">Text</a>) -> Self</h4></div></summary><divclass="docblock"><p>Draw a tooltip while hovering over this object.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.clickable"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#199-203"title="goto source code">[src]</a></div><ahref="#method.clickable"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.clickable"class="fnname">clickable</a>(self) -> Self</h4></div></summary><divclass="docblock"><p>Mark the object as clickable. <code>WorldOutcome::ClickedObject</code> will be fired.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.draggable"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#210-214"title="goto source code">[src]</a></div><ahref="#method.draggable"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.draggable"class="fnname">draggable</a>(self) -> Self</h4></div></summary><divclass="docblock"><p>Mark the object as draggable. The user can hover on this object, then click and drag it.
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.hotkey"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#218-222"title="goto source code">[src]</a></div><ahref="#method.hotkey"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.hotkey"class="fnname">hotkey</a><I: <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="../../event/enum.MultiKey.html"title="enum widgetry::event::MultiKey">MultiKey</a>>>(self, key: I, action: &'static <aclass="primitive"href="https://doc.rust-lang.org/1.56.1/std/primitive.str.html">str</a>) -> Self</h4></div></summary><divclass="docblock"><p>While the user hovers over this object, they can press a key to perform the specified
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.build"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../../../src/widgetry/mapspace/world.rs.html#225-251"title="goto source code">[src]</a></div><ahref="#method.build"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.build"class="fnname">build</a>(self, ctx: &mut <aclass="struct"href="../../event_ctx/struct.EventCtx.html"title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>)</h4></div></summary><divclass="docblock"><p>Finalize the object, adding it to the <code>World</code>.</p>
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#583-592"title="goto source code">[src]</a></div><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error"class="type trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.56.1/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#589"title="goto source code">[src]</a></div><ahref="#method.try_from"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#569-578"title="goto source code">[src]</a></div><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="associatedtype.Error-1"class="type trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.56.1/src/core/convert/mod.rs.html#575"title="goto source code">[src]</a></div><ahref="#method.try_into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.56.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.56.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
