Struct Layout

pub struct Layout {
    pub id: usize,
    pub bin: Bin,
    pub placed_items: SlotMap<PItemKey, PlacedItem>,
    /* private fields */
}

A Layout is made out of a Bin with a set of Items positioned inside of it in a specific way. It is a mutable representation, and can be modified by placing or removing items.

The layout is responsible for maintaining its CDEngine, ensuring that it always reflects the current state of the layout.

Fields

id: usize

The unique identifier of the layout, used only to match with a LayoutSnapshot.

bin: Bin

The bin used for this layout

placed_items: SlotMap<PItemKey, PlacedItem>

How the items are placed in the bin

Implementations

impl Layout

pub fn new(id: usize, bin: Bin) -> Self

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

pub fn change_bin(&mut self, bin: Bin)

pub fn create_snapshot(&mut self) -> LayoutSnapshot

pub fn restore(&mut self, layout_snapshot: &LayoutSnapshot)

pub fn clone_with_id(&self, id: usize) -> Self

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

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

pub fn is_empty(&self) -> bool

True if no items are placed

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

pub fn usage(&self) -> fsize

Returns the usage of the bin with the items placed. It is the ratio of the area of the items placed to the area of the bin.

pub fn id(&self) -> usize

pub fn cde(&self) -> &CDEngine

Returns the collision detection engine for this layout

pub fn flush_changes(&mut self)

Makes sure that the collision detection engine is completely updated with the changes made to the layout.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.