Struct UiSurface 

pub struct UiSurface {
    pub root_entity_to_viewport_node: EntityHashMap<NodeId>,
    /* private fields */
}

Fields

root_entity_to_viewport_node: EntityHashMap<NodeId>

Implementations

impl UiSurface

pub fn upsert_node( &mut self, layout_context: &LayoutContext, entity: Entity, node: &Node, new_node_context: Option<NodeMeasure>, )

Retrieves the Taffy node associated with the given UI node entity and updates its style. If no associated Taffy node exists a new Taffy node is inserted into the Taffy layout.

pub fn update_node_context( &mut self, entity: Entity, context: NodeMeasure, ) -> Option<()>

Update the MeasureFunc of the taffy node corresponding to the given Entity if the node exists.

pub fn update_children( &mut self, entity: Entity, children: impl Iterator<Item = Entity>, )

Update the children of the taffy node corresponding to the given Entity.

pub fn try_remove_children(&mut self, entity: Entity)

Removes children from the entity’s taffy node if it exists. Does nothing otherwise.

pub fn try_remove_node_context(&mut self, entity: Entity)

Removes the measure from the entity’s taffy node if it exists. Does nothing otherwise.

pub fn get_or_insert_taffy_viewport_node( &mut self, ui_root_entity: Entity, ) -> NodeId

Gets or inserts an implicit taffy viewport node corresponding to the given UI root entity

pub fn compute_layout<'a>( &mut self, ui_root_entity: Entity, render_target_resolution: UVec2, buffer_query: &'a mut Query<'_, '_, &mut ComputedTextBlock>, font_system: &'a mut CosmicFontSystem, )

Compute the layout for the given implicit taffy viewport node

pub fn remove_entities(&mut self, entities: impl IntoIterator<Item = Entity>)

Removes each entity from the internal map and then removes their associated nodes from taffy

pub fn get_layout( &mut self, entity: Entity, use_rounding: bool, ) -> Result<(Layout, Vec2), LayoutError>

Get the layout geometry for the taffy node corresponding to the ui node Entity. Does not compute the layout geometry, compute_window_layouts should be run before using this function. On success returns a pair consisting of the final resolved layout values after rounding and the size of the node after layout resolution but before rounding.

Trait Implementations

impl Debug for UiSurface

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

Formats the value using the given formatter.

impl Default for UiSurface

fn default() -> Self

Returns the “default value” for a type.

impl Resource for UiSurface

where Self: Send + Sync + 'static,