Struct substrate::geometry::prelude::Dims

pub struct Dims { /* private fields */ }

A horizontal and vertical rectangular dimension with no specified location.

Implementations

impl Dims

pub fn new(w: i64, h: i64) -> Dims

Creates a new Dims from a width and height.

pub fn square(value: i64) -> Dims

Creates a new Dims with width and height equal to value.

Example

assert_eq!(Dims::square(100), Dims::new(100, 100));

pub fn dim(&self, dir: Dir) -> i64

Returns the dimension in the specified direction.

Example

let dims = Dims::new(100, 200);
assert_eq!(dims.dim(Dir::Vert), 200);
assert_eq!(dims.dim(Dir::Horiz), 100);

pub fn longer_dir(&self) -> Dir

Returns the direction of the longer dimension.

If the width and height are equal, returns Dir::Horiz.

Example

let dims = Dims::new(100, 200);
assert_eq!(dims.longer_dir(), Dir::Vert);
let dims = Dims::new(200, 100);
assert_eq!(dims.longer_dir(), Dir::Horiz);
let dims = Dims::new(100, 100);
assert_eq!(dims.longer_dir(), Dir::Horiz);

pub fn longer_dir_strict(&self) -> Option<Dir>

Returns the direction of the longer dimension.

If the width and height are equal, returns None. Otherwise, returns a Some variant containing the longer direction.

pub fn transpose(self) -> Dims

Returns a new Dims object with the horizontal and vertical dimensions flipped.

pub fn width(&self) -> i64

Returns the width (i.e. the horizontal dimension).

pub fn height(&self) -> i64

Returns the height (i.e. the vertical dimension).

pub fn w(&self) -> i64

Returns the width (i.e. the horizontal dimension).

A shorthand for Dims::width.

pub fn h(&self) -> i64

Returns the height (i.e. the vertical dimension).

A shorthand for Dims::height.

pub fn into_rect(self) -> Rect

Converts this dimension object into a Rect.

See Rect::from_dims for more information.

pub fn into_point(self) -> Point

Converts this dimension object into a Point with coordinates (self.w(), self.h()).

Trait Implementations

impl Add<Dims> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Dims) -> <Point as Add<Dims>>::Output

Performs the + operation.

impl Add for Dims

type Output = Dims

The resulting type after applying the + operator.

fn add(self, rhs: Dims) -> <Dims as Add>::Output

Performs the + operation.

impl AddAssign<Dims> for Point

fn add_assign(&mut self, rhs: Dims)

Performs the += operation.

impl AddAssign for Dims

fn add_assign(&mut self, rhs: Dims)

Performs the += operation.

impl Clone for Dims

fn clone(&self) -> Dims

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dims

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

Formats the value using the given formatter.

impl Default for Dims

fn default() -> Dims

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dims

fn deserialize<__D>( __deserializer: __D ) -> Result<Dims, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Dims> for Rect

fn from(value: Dims) -> Rect

Converts the Dims to a Rect as described in Rect::from_dims.

impl From<Point> for Dims

fn from(value: Point) -> Dims

Create a new dimension object from a point.

The width field of the resulting Dims will be the point’s x-coordinate. The height field of the resulting Dims will be the point’s y-coordinate.

impl From<Rect> for Dims

fn from(value: Rect) -> Dims

Obtains Dims from the given Rect using Rect::dims.

impl Hash for Dims

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<(usize, usize)> for Dims

type Output = Dims

The resulting type after applying the * operator.

fn mul(self, rhs: (usize, usize)) -> <Dims as Mul<(usize, usize)>>::Output

Performs the * operation.

impl Mul<Dims> for Point

fn mul(self, rhs: Dims) -> <Point as Mul<Dims>>::Output

Multiplies the x-coordinate of the point by the dimension’s width, and the y-coordinate of the point by the dimension’s height.

type Output = Point

The resulting type after applying the * operator.

impl Mul<i64> for Dims

type Output = Dims

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> <Dims as Mul<i64>>::Output

Performs the * operation.

impl MulAssign<i64> for Dims

fn mul_assign(&mut self, rhs: i64)

Performs the *= operation.

impl Ord for Dims

fn cmp(&self, other: &Dims) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Dims

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

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

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

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

impl PartialOrd for Dims

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

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

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

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

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

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

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

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

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 Serialize for Dims

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Dims

type Output = Dims

The resulting type after applying the - operator.

fn sub(self, rhs: Dims) -> <Dims as Sub>::Output

Performs the - operation.

impl SubAssign for Dims

fn sub_assign(&mut self, rhs: Dims)

Performs the -= operation.

impl Copy for Dims

impl Eq for Dims

impl StructuralPartialEq for Dims