Struct Rectangle

pub struct Rectangle { /* private fields */ }

Rectangle specifies an area in a coordinate space that is defined an upper-left point, as defined by x and y, and the dimensions, defined by the Dimension object.

Implementations

impl Rectangle

pub fn new(x: i32, y: i32, dim: Dimension) -> Rectangle

Creates a new Rect whose upper-left corner is defined by x and y, and whose width and height are defined by the Dimension type.

pub fn x(&self) -> i32

Returns the x coordinate of the bounding Rectangle.

pub fn y(&self) -> i32

Returns the y coordinate of the bounding Rectangle.

pub fn set_x(&mut self, x: i32)

Moves this Rectangle horizontally to the location specified by x.

pub fn set_y(&mut self, y: i32)

Moves this Rectangle vertically to the location specified by y.

pub fn set_location(&mut self, x: i32, y: i32)

Moves this Rectangle to the location specified by x and y.

pub fn translate(&mut self, dx: i32, dy: i32)

Translates this Rectangle the indicated distance, to the right along the X axis, and downward along the Y axis.

Note: Underflow and overflow are bound by i32::MIN and i32::MAX respectively.

pub fn id(&self) -> isize

Returns the identifier associated with the Rectangle.

pub fn width(&self) -> i32

Returns the width of the bounding Rectangle without padding.

pub fn height(&self) -> i32

Returns the height of the bounding Rectangle without padding.

pub fn dim(&self) -> &Dimension

Returns an immutable reference to the associated Dimension object.

pub fn dim_mut(&mut self) -> &mut Dimension

Returns a mutable reference to the associated Dimension object.

pub fn is_empty(&self) -> bool

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

Padding is not included in the check.

pub fn contains(&self, rect: &Rectangle) -> bool

Checks whether or not this Rectangle entirely contains the specified Rectangle.

Padding is not included in the check.

pub fn intersects(&self, rect: &Rectangle) -> bool

Checks whether or not this Rectangle and the specified Rectangle intersect.

Padding is not included in the check.

pub fn union(&self, rect: &Rectangle, id: Option<isize>) -> Self

Computes the union of this Rectangle with the specified Rectangle.

rect specifies the second rectangle to use for the union.

id will be used as new identifier for the dimension included the returned Rectangle. An identifier is autogenerated if if None is specified.

The greater padding of the source Rectangles is applied to the returned Rectangle.

Returns a new Rectangle that represents the union of the two rectangles.

Trait Implementations

impl Clone for Rectangle

fn clone(&self) -> Rectangle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rectangle

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

Formats the value using the given formatter.

impl Default for Rectangle

fn default() -> Rectangle

Returns the “default value” for a type.

impl Display for Rectangle

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 Rectangle

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

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

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

const 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 Rectangle

fn partial_cmp(&self, other: &Rectangle) -> 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 Rectangle

impl Eq for Rectangle

impl StructuralPartialEq for Rectangle