Struct ambient_api::prelude::Element

pub struct Element { /* private fields */ }

A rendered ElementComponent instance.

Implementations

impl Element

pub fn new() -> Element

Creates a new Element with no children.

pub fn from_element_component(part: Box<dyn ElementComponent>) -> Element

Creates a new Element from the given component.

pub fn vec_of(self) -> Vec<Element>

Convenience method to construct a Vec<Element> from a single Element.

pub fn with<T>(self, component: Component<T>, value: T) -> Element

where T: SupportedValue + Sync + Send + Clone + 'static,

Adds the given component with value to the element.

pub fn init<T>(self, component: Component<T>, value: T) -> Element

where T: SupportedValue + Sync + Send + Clone + 'static,

Sets the given component to value on the element during initialization only.

pub fn init_default<T>(self, component: Component<T>) -> Element

where T: SupportedValue + Sync + Send + Clone + Default + 'static,

Calls Self::init with the default value for the component’s type.

pub fn remove<T>(self, component: Component<T>) -> Element

where T: SupportedValue + Clone,

Removes the given component from the element.

Warning: this only removes components on the current element.

pub fn children(self, children: Vec<Element>) -> Element

Sets the children of the element.

pub fn spawner<F>(self, handler: F) -> Element

where F: Fn(&mut World, Entity) -> EntityId + Sync + Send + 'static,

Set the function used to spawn the element.

pub fn despawner<F>(self, handler: F) -> Element

where F: Fn(&mut World, EntityId) + Sync + Send + 'static,

Set the function used to despawn the element.

pub fn on_spawned<F>(self, handler: F) -> Element

where F: Fn(&mut World, EntityId, &str) + Sync + Send + 'static,

Set the callback to call when the element is spawned. The third argument is the instance ID.

pub fn on_despawn<F>(self, handler: F) -> Element

where F: Fn(&mut World, EntityId, &str) + Sync + Send + 'static,

Set the callback to call when the element is despawned. The third argument is the instance ID.

pub fn key<T>(self, key: T) -> Element

where T: Into<String>,

Set the unique key used to identify this element.

This is used to disambiguate elements with the same type. This should be used when rendering lists of elements.

pub fn memoize_subtree(self, memo_key: impl Into<String>) -> Element

Avoid rendering the subtree, except when the memo_key is changed.

pub fn has_component(&self, component: impl Into<ComponentDesc>) -> bool

Returns true if the element has the given component.

pub fn spawn_tree(self) -> ElementTree

Available on crate feature guest only.

This spawns the elemet tree and returns it. The tree won’t be automatically updated, but can manually be updated by calling the update method.

pub fn spawn_interactive(self)

Available on crate feature guest only.

This spawns the element tree and sets up listeners to automatically update it.

This is equivalent to calling Self::spawn_tree and then calling ElementTree::update on the tree each frame.

You may want to update the tree manually if you want to replace the root Element:

let mut tree = Element::new().spawn_tree();
Frame::subscribe(move |_| {
    if some_condition {
        tree.migrate_root(&mut World, App::el(new_properties));
    }
    tree.update(&mut World);
});

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Element

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Element

fn default() -> Element

Returns the “default value” for a type.

impl From<Element> for UIElement

fn from(el: Element) -> UIElement

Converts to this type from the input type.

impl<T> From<T> for Element

where T: ElementComponent + 'static,

fn from(part: T) -> Element

Converts to this type from the input type.

impl StylesExt for Element

fn section_style(self) -> Element

Apply the default style for a section header.

fn header_style(self) -> Element

Apply the default style for a header.

fn small_style(self) -> Element

Apply the default style for a small text.

fn error_text_style(self) -> Element

Apply the default style for an error text.

fn floating_panel(self) -> Element

Apply the default style for a floating panel.

fn panel(self) -> Element

Apply the default style for a panel.

fn keyboard(self) -> Element

A list of items with some space between them.

impl UIExt for Element

fn with_clickarea(self) -> ClickArea

Wraps this element in a ClickArea element.

fn with_background(self, background: Vec4) -> Element

Adds a background color to this element.

fn with_padding_even(self, value: f32) -> Element

Adds padding to all sides of this element.

fn with_margin_even(self, value: f32) -> Element

Adds margin to all sides of this element.