Struct Layout 

pub struct Layout { /* private fields */ }

A Layout is a dynamic representation of items that have been placed in a container at specific positions. Items can be placed and removed. The container can be swapped. Snapshots can be taken and restored to. Each layout maintains a CDEngine, which can be used to check for collisions before placing items.

Implementations

impl Layout

pub fn new(container: Container) -> Self

pub fn from_snapshot(ls: &LayoutSnapshot) -> Self

pub fn swap_container(&mut self, container: Container)

Replaces the current container with a new one, rebuilding the collision detection engine accordingly.

pub fn save(&self) -> LayoutSnapshot

Saves the current state of the layout to be potentially restored to later.

pub fn restore( &mut self, layout_snapshot: &LayoutSnapshot, ) -> Result<(), ContainerMismatch>

Restores the layout from a snapshot.

Errors

Returns ContainerMismatch if the snapshot uses a different container, leaving the layout unchanged. Use Layout::swap_container first or Layout::from_snapshot to restore a snapshot with a different container.

pub fn place_item( &mut self, item: &Arc<Item>, d_transformation: DTransformation, ) -> PItemKey

Places an item in the layout at a specific position by applying a transformation. Returns the unique key for the placed item. Does not check collisions or orientation permissions before placement.

pub fn remove_item(&mut self, pk: PItemKey) -> PlacedItem

Removes an item from the layout by its unique key and returns the removed PlacedItem.

pub fn is_empty(&self) -> bool

True if no items are placed

pub fn density(&self) -> f32

The current density of the layout defined as the ratio of the area of the items placed to the area of the container. Uses the original shapes of items and container to calculate the area.

pub fn placed_item_area(&self) -> f32

The sum of the areas of the items placed in the layout (using the original shapes of the items).

pub fn items(&self) -> impl Iterator<Item = &Item>

Distinct item types present in this layout.

pub fn cde(&self) -> &CDEngine

Returns the collision detection engine for this layout

pub fn is_collision_free(&self) -> bool

Returns true if no placed item collides with the container or another item. Quality zones meeting each item’s minimum quality are ignored; holes remain blocking.

pub fn container(&self) -> &Container

The container used for this layout

pub fn placed_items(&self) -> &SlotMap<PItemKey, PlacedItem>

All the items that have been placed in this layout, indexed by a unique key

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.