Struct semeion::space::Dimension

pub struct Dimension {
    pub x: i32,
    pub y: i32,
}

The dimension of a rectangular grid as the integer number of columns and rows.

Fields

x: i32

y: i32

Implementations

impl Dimension

pub fn with_eq_rectangles(count: usize) -> Self

Constructs new dimension where the overall rectangle is composed by the lowest number of rectangles of equal size lower than the given count, so that they should be aligned in such a manner that the number of rows and number of columns are equal (with the last row possibly not being completely filled).

pub fn len(self) -> usize

Gets the number of tiles in a grid of given Dimension, equal to the number of row by the number of columns.

pub fn is_empty(self) -> bool

Returns true only if the number of tiles in the grid is 0.

pub fn is_square(self) -> bool

Returns true only if the components of this Dimension are equal in magnitude, that is, self.x == self.y, and therefore this Dimension represents a square.

pub fn center(self) -> Location

Gets the Location of the center of this Dimension.

pub fn contains(self, location: impl Into<Location>) -> bool

Returns true only if the given Location is within this Dimension.

pub fn aspect_ratio(self) -> f32

Gets the aspect ratio of this Dimension.

pub fn scale(self, other: impl Into<Self>) -> Self

Maps self with the given Dimension, and returns the number of rows and columns (as new Dimension) that each tile of the given Dimension would have to occupy so that all its tiles would fill up self.

Trait Implementations

impl Clone for Dimension

pub fn clone(&self) -> Dimension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Dimension

impl Debug for Dimension

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

Formats the value using the given formatter.

impl Default for Dimension

pub fn default() -> Dimension

Returns the "default value" for a type.

impl Eq for Dimension

impl From<(i32, i32)> for Dimension

pub fn from((x, y): (i32, i32)) -> Self

Performs the conversion.

impl From<Dimension> for (i32, i32)

pub fn from(dimension: Dimension) -> Self

Performs the conversion.

impl Hash for Dimension

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Dimension

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

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

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

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

This method tests for !=.

impl PartialOrd<Dimension> for Dimension

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Dimension

impl StructuralPartialEq for Dimension