Struct LayoutTree 

pub struct LayoutTree { /* private fields */ }

Arena-based mutable layout tree.

Implementations

impl LayoutTree

pub fn new() -> Self

Create an empty tree with no nodes.

pub fn add_panel( &mut self, kind: impl Into<Arc<str>>, constraints: Constraints, ) -> Result<(PanelId, NodeId), PaneError>

Add a panel node. Returns the generated PanelId and the arena NodeId.

pub fn add_row( &mut self, gap: f32, children: Vec<NodeId>, ) -> Result<NodeId, PaneError>

Add a row container with the given gap and children.

pub fn add_col( &mut self, gap: f32, children: Vec<NodeId>, ) -> Result<NodeId, PaneError>

Add a column container with the given gap and children.

pub fn add_taffy_node( &mut self, style: Style, children: Vec<NodeId>, ) -> Result<NodeId, PaneError>

Add a raw Taffy passthrough node.

pub fn set_root(&mut self, id: NodeId)

Set the root node of the tree.

pub fn root(&self) -> Option<NodeId>

Return the root node id, if set.

pub fn node(&self, id: NodeId) -> Option<&Node>

Look up a node by id.

pub fn is_dirty(&self) -> bool

Whether the tree structure has changed since last compile.

pub fn clear_dirty(&mut self)

Clear the dirty flag after a successful compile.

pub fn panel_id_high_water(&self) -> u32

One past the highest issued PanelId. Used to size Vec-indexed storage.

pub fn arena_len(&self) -> usize

Total slots in the node arena (including tombstones).

pub fn node_count(&self) -> usize

Total number of live nodes in the arena.

pub fn panel_count(&self) -> usize

Total number of panel nodes in the tree.

pub fn window_size(&self) -> usize

How many panels the active window shows at once. Default is 1. Scrollable sets this to 2.

pub fn set_window_size(&mut self, size: usize)

Set the active window size.

pub fn kind_count(&self) -> usize

Total number of distinct panel kinds.

pub fn kinds(&self) -> impl Iterator<Item = &Arc<str>>

All distinct panel kinds.

pub fn panels_by_kind(&self, kind: &str) -> &[PanelId]

All PanelIds with the given kind.

pub fn set_constraints( &mut self, pid: PanelId, constraints: Constraints, ) -> Result<(), PaneError>

Update a panel’s constraints.

pub fn panel_constraints(&self, pid: PanelId) -> Result<Constraints, PaneError>

Get a panel’s current constraints.

pub fn panel_kind(&self, pid: PanelId) -> Result<&str, PaneError>

Get a panel’s kind.

pub fn children(&self, id: NodeId) -> Result<&[NodeId], PaneError>

Get the children of a node. Returns an empty slice for leaf nodes.

pub fn parent(&self, id: NodeId) -> Result<Option<NodeId>, PaneError>

Get the parent of a node. Returns None for root nodes.

pub fn node_for_panel(&self, pid: PanelId) -> Option<NodeId>

Resolve a PanelId to its arena NodeId, if present.

pub fn insert_child_at( &mut self, container: NodeId, idx: usize, child: NodeId, ) -> Result<(), PaneError>

Insert a child into a container at the given index, updating parent_map.

pub fn remove_panel(&mut self, pid: PanelId) -> Result<(), PaneError>

Remove a panel from the tree entirely.

pub fn move_panel( &mut self, pid: PanelId, position: Position, ) -> Result<(), PaneError>

Move a panel to a new position (possibly in a different container).

pub fn validate(&self) -> Result<(), PaneError>

Check structural integrity of the tree.

pub fn insert_node( &mut self, node_id: NodeId, container_id: NodeId, position: Position, ) -> Result<(), PaneError>

Insert a node into a container at a position relative to an anchor.

pub fn resolve( &self, width: f32, height: f32, ) -> Result<ResolvedLayout, PaneError>

Compile, compute, and resolve in one call.

Trait Implementations

impl Default for LayoutTree

fn default() -> Self

Returns the “default value” for a type.

impl From<Layout> for LayoutTree

fn from(layout: Layout) -> Self

Converts to this type from the input type.

impl From<LayoutTree> for LayoutRuntime

fn from(tree: LayoutTree) -> Self

Converts to this type from the input type.