Struct Rectangle

pub struct Rectangle<T = f32> {
    pub x: T,
    pub y: T,
    pub width: T,
    pub height: T,
}

An axis-aligned rectangle.

Fields

x: T

X coordinate of the top-left corner.

y: T

Y coordinate of the top-left corner.

width: T

Width of the rectangle.

height: T

Height of the rectangle.

Implementations

impl<T> Rectangle<T>

where T: Default,

pub fn with_size(size: Size<T>) -> Rectangle<T>

Creates a new Rectangle with its top-left corner at the origin and with the provided Size.

impl Rectangle

pub const INFINITE: Rectangle

A rectangle starting at Point::ORIGIN with infinite width and height.

pub const fn new(top_left: Point, size: Size) -> Rectangle

Creates a new Rectangle with its top-left corner in the given Point and with the provided Size.

pub fn with_radius(radius: f32) -> Rectangle

Creates a new square Rectangle with the center at the origin and with the given radius.

pub fn with_vertices( top_left: Point, top_right: Point, bottom_left: Point, ) -> (Rectangle, Radians)

Creates a new axis-aligned Rectangle from the given vertices; returning the rotation in Radians that must be applied to the axis-aligned Rectangle to obtain the desired result.

pub fn center(&self) -> Point

Returns the Point at the center of the Rectangle.

pub fn center_x(&self) -> f32

Returns the X coordinate of the Point at the center of the Rectangle.

pub fn center_y(&self) -> f32

Returns the Y coordinate of the Point at the center of the Rectangle.

pub fn position(&self) -> Point

Returns the position of the top left corner of the Rectangle.

pub fn size(&self) -> Size

Returns the Size of the Rectangle.

pub fn area(&self) -> f32

Returns the area of the Rectangle.

pub fn contains(&self, point: Point) -> bool

Returns true if the given Point is contained in the Rectangle.

pub fn distance(&self, point: Point) -> f32

Returns the minimum distance from the given Point to any of the edges of the Rectangle.

pub fn is_within(&self, container: &Rectangle) -> bool

Returns true if the current Rectangle is completely within the given container.

pub fn intersection(&self, other: &Rectangle) -> Option<Rectangle>

Computes the intersection with the given Rectangle.

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

Returns whether the Rectangle intersects with the given one.

pub fn union(&self, other: &Rectangle) -> Rectangle

Computes the union with the given Rectangle.

pub fn snap(self) -> Option<Rectangle<u32>>

Snaps the Rectangle to unsigned integer coordinates.

pub fn expand(self, padding: impl Into<Padding>) -> Rectangle

Expands the Rectangle a given amount.

pub fn shrink(self, padding: impl Into<Padding>) -> Rectangle

Shrinks the Rectangle a given amount.

pub fn rotate(self, rotation: Radians) -> Rectangle

Rotates the Rectangle and returns the smallest Rectangle containing it.

Trait Implementations

impl<T> Add<Vector<T>> for Rectangle<T>

where T: Add<Output = T>,

type Output = Rectangle<T>

The resulting type after applying the + operator.

fn add(self, translation: Vector<T>) -> Rectangle<T>

Performs the + operation.

impl<T> Clone for Rectangle<T>

where T: Clone,

fn clone(&self) -> Rectangle<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Rectangle<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Rectangle<T>

where T: Default,

fn default() -> Rectangle<T>

Returns the “default value” for a type.

impl From<Rectangle<u32>> for Rectangle

fn from(rectangle: Rectangle<u32>) -> Rectangle

Converts to this type from the input type.

impl Mul<Transformation> for Rectangle

type Output = Rectangle

The resulting type after applying the * operator.

fn mul(self, transformation: Transformation) -> Rectangle

Performs the * operation.

impl<T> Mul<Vector<T>> for Rectangle<T>

where T: Mul<Output = T> + Copy,

type Output = Rectangle<T>

The resulting type after applying the * operator.

fn mul(self, scale: Vector<T>) -> Rectangle<T>

Performs the * operation.

impl Mul<f32> for Rectangle

type Output = Rectangle

The resulting type after applying the * operator.

fn mul(self, scale: f32) -> Rectangle

Performs the * operation.

impl<T> PartialEq for Rectangle<T>

where T: PartialEq,

fn eq(&self, other: &Rectangle<T>) -> 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<T> Sub<Vector<T>> for Rectangle<T>

where T: Sub<Output = T>,

type Output = Rectangle<T>

The resulting type after applying the - operator.

fn sub(self, translation: Vector<T>) -> Rectangle<T>

Performs the - operation.

impl<T> Copy for Rectangle<T>

where T: Copy,

impl<T> Eq for Rectangle<T>

where T: Eq,

impl<T> StructuralPartialEq for Rectangle<T>