Struct rectangle_pack::BinSection

pub struct BinSection { /* fields omitted */ }

A rectangular section within a target bin that takes up one or more layers

Implementations

impl BinSection

pub fn overlaps(&self, other: &Self) -> bool

Whether or not two bin sections overlap each other.

impl BinSection

pub fn new(x: u32, y: u32, z: u32, whd: WidthHeightDepth) -> Self

Create a new BinSection

impl BinSection

pub fn try_place(
    &self,
    incoming: &RectToInsert,
    container_comparison_fn: &ComparePotentialContainersFn,
    heuristic_fn: &BoxSizeHeuristicFn
) -> Result<(PackedLocation, [BinSection; 3]), BinSectionError>

See if a LayeredRect can fit inside of this BinSection.

If it can we return the BinSections that would be created by placing the LayeredRect inside of this BinSection.

Consider the diagram below of a smaller box placed into of a larger one.

The remaining space can be divided into three new sections.

There are several ways to make this division.

You could keep all of the space above the smaller box intact and split up the space behind and to the right of it.

But within that you have a choice between whether the overlapping space goes to right or behind box.

Or you could keep the space to the right and split the top and behind space.

etc.

There are six possible configurations of newly created sections. The configuration to use is decided on based on a a function provided by the consumer.

            ┌┬───────────────────┬┐
          ┌─┘│                 ┌─┘│
        ┌─┘  │               ┌─┘  │
      ┌─┘    │             ┌─┘    │
    ┌─┘      │           ┌─┘      │
  ┌─┘        │         ┌─┘        │
┌─┴──────────┼───────┬─┘          │
│            │       │            │
│            │       │            │
│       ┌┬───┴────┬─┐│            │
│     ┌─┘│      ┌─┘ ││            │
│   ┌─┘  │    ┌─┘   ││            │
│ ┌─┘    │  ┌─┘     ├┼───────────┬┘
├─┴──────┤ ─┘       ││         ┌─┘
│       ┌┴─┬───────┬┘│       ┌─┘   
│     ┌─┘  │     ┌─┘ │     ┌─┘     
│   ┌─┘    │   ┌─┘   │   ┌─┘       
│ ┌─┘      │ ┌─┘     │ ┌─┘         
└─┴────────┴─┴───────┴─┘           

Note

Written to be readable/maintainable, not to minimize conditional logic, under the (unverified) assumption that a release compilation will inline and dedupe the function calls and conditionals.

Trait Implementations

impl Clone for BinSection

fn clone(&self) -> BinSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BinSection

impl Debug for BinSection

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

Formats the value using the given formatter.

impl Default for BinSection

fn default() -> BinSection

Returns the “default value” for a type.

impl Eq for BinSection

impl Ord for BinSection

fn cmp(&self, other: &BinSection) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<BinSection> for BinSection

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BinSection> for BinSection

fn partial_cmp(&self, other: &BinSection) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BinSection

impl StructuralPartialEq for BinSection