Struct MaxRectsBin 

pub struct MaxRectsBin { /* private fields */ }

A two-dimensional rectangle bin packer using the MAXRECTS data structure and different bin packing algorithms that use this structure.

It can be used to pack multiple rectangles of arbitrary size into a “bin” of rectangular shape with the goal to add as many rectangles as possible into the bin.

Implementations

impl MaxRectsBin

pub fn new(width: i32, height: i32) -> Self

Creates an empty bin of the given size.

Minimum width and height of a bin is 1.

pub fn with_capacity(width: i32, height: i32, capacity: usize) -> Self

Creates an empty bin of the given size and reserves space for at least capacity number of mapped rectangle to improve performance.

Minimum width and height of a bin is 1.

pub fn default_rule(&self) -> Heuristic

Returns the default Heuristic rule, which is used by the BinPacker trait’s insert and insert_list methods.

pub fn set_default_rule(&mut self, rule: Heuristic)

Can be used to override the default Heuristic rule, which is used by the BinPacker trait’s insert and insert_list methods.

pub fn insert(&mut self, dim: &Dimension, rule: Heuristic) -> Option<Rectangle>

Inserts a single Dimension object into the bin.

dim refers to the object to be packed into the bin.

rule specifies the rectangle placement rule to use for the packing operation.

Returns a copy of the packed Rectangle if the object was inserted successful, or None otherwise.

pub fn insert_list( &mut self, nodes: &[Dimension], rule: Heuristic, ) -> (Vec<Rectangle>, Vec<Dimension>)

Attempts to insert the given list of Dimension objects into the bin.

nodes specifies the list of Dimension objects to insert. All successfully inserted objects will be removed from the list in the process.

rule specifies the rectangle placement rule to use for the packing operations.

Returns a list with all successfully inserted Rectangle objects.

This method performs slower than insert, but may result in more tightly packed bins for greater numbers of dimension objects.

Trait Implementations

impl BinPacker for MaxRectsBin

fn width(&self) -> i32

Returns the width of the bin.

fn height(&self) -> i32

Returns the height of the bin.

fn clear_with(&mut self, capacity: usize)

Just as clear, this method removes all mapped rectangle from the bin, but also sets initial capacity of the internal rectangle lists to improve performance.

fn grow(&mut self, dw: u32, dh: u32)

Increases dimension of the bin by the specified values.

fn shrink(&mut self, binary: bool)

Attempts to shrink the bin as much as possible.

fn insert(&mut self, dim: &Dimension) -> Option<Rectangle>

Inserts a single Dimension object into the bin.

fn insert_list( &mut self, nodes: &[Dimension], ) -> (Vec<Rectangle>, Vec<Dimension>)

Attempts to insert the given list of Dimension objects into the bin.

fn occupancy(&self) -> f32

Computes the ratio of used surface area to the total bin area and returns it as a normalized value in the range [0.0, 1.0].

fn as_slice(&self) -> &[Rectangle]

Extracts a slice containing the entire list of mapped rectangles.

fn is_empty(&self) -> bool

Returns true if the list of mapped rectangles contains no entries.

fn len(&self) -> usize

Returns the number of mapped rectangles in this Bin.

fn iter(&self) -> Iter<'_, Rectangle>

Returns an iterator over the list of mapped rectangles.

fn find_by_id(&self, id: isize) -> Option<Rectangle>

Returns the first mapped rectangle with the specified identifier, if available. Returns None otherwise.

fn visualize(&self) -> String

Returns a visual representation of the bin as ascii graphics String.

fn clear(&mut self)

Removes all mapped rectangles from the bin.

impl Clone for MaxRectsBin

fn clone(&self) -> MaxRectsBin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaxRectsBin

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

Formats the value using the given formatter.

impl Display for MaxRectsBin

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

Formats the value using the given formatter.

impl<Idx> Index<Idx> for MaxRectsBin

where Idx: SliceIndex<[Rectangle]>,

type Output = <Idx as SliceIndex<[Rectangle]>>::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for MaxRectsBin

fn eq(&self, other: &MaxRectsBin) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MaxRectsBin