Struct Rectangle

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

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§

Source§

impl<T> Rectangle<T>
where T: Default,

Source

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

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

Source§

impl Rectangle<f32>

Source

pub const INFINITE: Self

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

Source

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

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

Source

pub fn with_radius(radius: f32) -> Self

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

Source

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.

Source

pub fn center(&self) -> Point

Returns the Point at the center of the Rectangle.

Source

pub fn center_x(&self) -> f32

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

Source

pub fn center_y(&self) -> f32

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

Source

pub fn position(&self) -> Point

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

Source

pub fn size(&self) -> Size

Returns the Size of the Rectangle.

Source

pub fn area(&self) -> f32

Returns the area of the Rectangle.

Source

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

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

Source

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

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

Source

pub fn offset(&self, container: &Rectangle) -> Vector

Computes the offset that must be applied to the Rectangle to be placed inside the given container.

Source

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

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

Source

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

Computes the intersection with the given Rectangle.

Source

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

Returns whether the Rectangle intersects with the given one.

Source

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

Computes the union with the given Rectangle.

Source

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

Snaps the Rectangle to unsigned integer coordinates.

Source

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

Expands the Rectangle a given amount.

Source

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

Shrinks the Rectangle a given amount.

Source

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

Rotates the Rectangle and returns the smallest Rectangle containing it.

Source

pub fn zoom(self, zoom: f32) -> Self

Scales the Rectangle without changing its position, effectively “zooming” it.

Trait Implementations§

Source§

impl<T> Add<Vector<T>> for Rectangle<T>
where T: Add<Output = T>,

Source§

type Output = Rectangle<T>

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl<T: Clone> Clone for Rectangle<T>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Rectangle<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Rectangle<T>

Source§

fn default() -> Rectangle<T>

Returns the “default value” for a type. Read more
Source§

impl From<Rectangle<u32>> for Rectangle<f32>

Source§

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

Converts to this type from the input type.
Source§

impl Mul<Transformation> for Rectangle

Source§

type Output = Rectangle

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl<T> Mul<Vector<T>> for Rectangle<T>
where T: Mul<Output = T> + Copy,

Source§

type Output = Rectangle<T>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul<f32> for Rectangle<f32>

Source§

type Output = Rectangle

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl<T: PartialEq> PartialEq for Rectangle<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> Sub<Vector<T>> for Rectangle<T>
where T: Sub<Output = T>,

Source§

type Output = Rectangle<T>

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl<T: Copy> Copy for Rectangle<T>

Source§

impl<T: Eq> Eq for Rectangle<T>

Source§

impl<T> StructuralPartialEq for Rectangle<T>

Auto Trait Implementations§

§

impl<T> Freeze for Rectangle<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Rectangle<T>
where T: RefUnwindSafe,

§

impl<T> Send for Rectangle<T>
where T: Send,

§

impl<T> Sync for Rectangle<T>
where T: Sync,

§

impl<T> Unpin for Rectangle<T>
where T: Unpin,

§

impl<T> UnwindSafe for Rectangle<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T