Struct LayoutEngine 

pub struct LayoutEngine { /* private fields */ }

Implementations

impl LayoutEngine

pub fn new() -> Self

pub fn direction(&self) -> Direction

The direction logical edges currently resolve against.

pub fn set_direction(&mut self, direction: Direction) -> bool

Re-resolves every direction-dependent node against direction, returning whether anything changed. The caller still has to mark the tree dirty and recompute — this only rewrites styles.

This is what lets one build serve both directions: rather than rebuilding the widget tree, each node that was authored logically is resolved again from the intent recorded when it was created.

pub fn new_leaf(&mut self, style: LayoutStyle) -> Result<NodeId, LayoutError>

pub fn new_measured_leaf( &mut self, style: LayoutStyle, measure: MeasureFn, ) -> Result<NodeId, LayoutError>

pub fn new_container( &mut self, style: LayoutStyle, children: &[NodeId], ) -> Result<NodeId, LayoutError>

pub fn set_style( &mut self, node: NodeId, style: LayoutStyle, ) -> Result<(), LayoutError>

pub fn set_children( &mut self, parent: NodeId, children: &[NodeId], ) -> Result<(), LayoutError>

Replaces parent’s children with children, in order. Used by reactive lists to insert, move, and drop item nodes as their source collection changes.

pub fn add_child( &mut self, parent: NodeId, child: NodeId, ) -> Result<(), LayoutError>

Appends child to parent’s existing children (unlike [set_children], which replaces them). Used to attach an overlay’s out-of-flow content to the layout root without touching the root’s other children.

pub fn remove_child( &mut self, parent: NodeId, child: NodeId, ) -> Result<(), LayoutError>

Detaches child from parent (does not free it — call [remove] afterwards to release the node).

pub fn remove(&mut self, node: NodeId)

Frees a node (and its measure context) from the tree. The caller must have already detached it from its parent (via [set_children]); a removed node id must not be used again.

pub fn mark_dirty(&mut self, node: NodeId) -> Result<(), LayoutError>

pub fn is_size_auto(&self, node: NodeId) -> (bool, bool)

Whether the node’s width/height are auto (i.e. content-sized).

pub fn set_width(&mut self, node: NodeId, width: Option<f32>)

Sets the node’s width to a definite length, or back to auto when None.

pub fn set_height(&mut self, node: NodeId, height: Option<f32>)

Sets the node’s height to a definite length, or back to auto when None.

pub fn set_min_height(&mut self, node: NodeId, height: Option<f32>)

Sets the node’s minimum height to a definite length, or clears it (auto) when None. Lets a content-measured leaf (e.g. a code editor’s text area) fill a viewport it would otherwise underflow.

pub fn is_row(&self, node: NodeId) -> bool

Whether the node lays its children along the main (horizontal) axis — a flex row. A column, or any non-row node (missing / errored), is false. A transparent fragment reads its host’s axis to know which margin edge a per-item gap sits on.

pub fn set_leading_margin(&mut self, node: NodeId, is_row: bool, px: f32)

Sets the node’s leading margin on the host’s main axis (top for a column; for a row, whichever horizontal edge the host lays out from) to px, leaving the other edges untouched. A transparent for … gap:N uses this to space its items by a gap without a container of its own: the item cell carries the gap as a margin instead.

pub fn set_display(&mut self, node: NodeId, visible: bool)

Toggles a node in or out of layout flow. A hidden node (Display::None) takes no space and lays out none of its subtree; a visible node is Display::Flex. Used for responsive show/hide (e.g. collapsing a sidebar on narrow windows).

pub fn compute_layout( &mut self, root: NodeId, available_width: AvailableSpace, available_height: AvailableSpace, ) -> Result<(), LayoutError>

pub fn is_dirty(&self, node: NodeId) -> bool

pub fn layout(&self, node: NodeId) -> Result<Rect, LayoutError>

pub fn is_fixed_size(&self, node: NodeId) -> Option<(f32, f32)>

pub fn collect_dirty_nodes(&self, root: NodeId, out: &mut Vec<NodeId>)

pub fn walk<F>(&self, root: NodeId, f: &mut F) -> Result<(), LayoutError>

where F: FnMut(NodeId, Rect) -> bool,

Trait Implementations

impl Default for LayoutEngine

fn default() -> Self

Returns the “default value” for a type.