Struct Dimension 

pub struct Dimension { /* private fields */ }

The Dimension struct stores information about width, height and optional padding of an object.

Padding can be used to ensure that rectangles are placed into bins with spacing to each other.

An identifier is provided for custom identification purposes.

Implementations

impl Dimension

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

Creates a new Dimension object with the specified dimensions, an auto-generated identifier and no padding.

Negative values for width and height are capped at 0.

Note: Auto-generated identifiers can be considered unique, as long as they are not duplicated by with_id, set_id or cloning.

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

Creates a new Dimension object with the specified dimensions, an auto-generated identifier and optional padding.

Negative values for width, height and padding are capped at 0.

Note: Auto-generated identifiers can be considered unique, as long as they are not duplicated by with_id, set_id or cloning.

pub fn with_id(id: isize, width: i32, height: i32, padding: i32) -> Self

Creates a new Dimension object with the specified dimension, identifier and optional padding.

Negative values for width, height and padding are capped at 0.

pub fn id(&self) -> isize

Returns the identifier of the Dimension.

pub fn width(&self) -> i32

Returns width of the Dimension.

pub fn height(&self) -> i32

Returns height of the Dimension.

pub fn padding(&self) -> i32

Returns the padding of the Dimension.

pub fn set_id(&mut self, value: isize)

Assigns a new identifier to Dimension.

pub fn set_width(&mut self, value: i32)

Sets width of the Dimension to the specified value.

A negative value for width is capped at 0.

pub fn set_height(&mut self, value: i32)

Sets height of the Dimension to the specified value.

A negative value for height is capped at 0.

pub fn set_dimension(&mut self, width: i32, height: i32)

Sets both width and height of the Dimension.

Negative values for width and height are capped at 0.

pub fn set_padding(&mut self, value: i32)

Sets padding of the Dimension to the specified value.

A negative value for padding is capped at 0.

pub fn flip(&mut self)

Flips the Dimension by 90 degrees.

pub fn to_flipped(&self) -> Self

Creates a new Dimension from the current instance, which is flipped by 90 degrees.

pub fn is_empty(&self) -> bool

Returns true if width or height of the Dimension is 0, and false otherwise.

pub fn area(&self) -> i64

Computes the area of this Dimension.

Trait Implementations

impl Clone for Dimension

fn clone(&self) -> Dimension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dimension

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

Formats the value using the given formatter.

impl Default for Dimension

fn default() -> Self

Returns the “default value” for a type.

impl Display for Dimension

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

Formats the value using the given formatter.

impl From<Dimension> for Rectangle

fn from(value: Dimension) -> Self

Converts to this type from the input type.

impl Ord for Dimension

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Dimension

fn eq(&self, other: &Dimension) -> 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 PartialOrd for Dimension

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Dimension

impl Eq for Dimension

impl StructuralPartialEq for Dimension