Skip to main content

Rectangle2

Struct Rectangle2 

Source
pub struct Rectangle2 {
    pub origin: Point2,
    pub x: Vec2,
    pub y: Vec2,
}
Expand description

A rectangle in the XY-plane, possibly rotated.

Stored as a corner and two edge vectors so the parallelogram property holds by construction, matching Rectangle3. Perpendicularity is not enforced: a sheared import stays representable and inspectable.

Fields§

§origin: Point2

Corner the edge vectors start from.

§x: Vec2

First edge vector, from origin.

§y: Vec2

Second edge vector, from origin.

Implementations§

Source§

impl Rectangle2

Source

pub const fn new(origin: Point2, x: Vec2, y: Vec2) -> Self

Construct from a corner and two edge vectors.

Source

pub fn from_aabb(bounds: &Aabb2) -> Option<Self>

An axis-aligned rectangle spanning bounds.

Returns None for an empty box, because an inverted corner pair has no meaningful edge vectors and silently producing a zero-sized rectangle at the origin would hide the emptiness from the caller.

Source

pub fn corners(&self) -> [Point2; 4]

The four corners, in order around the boundary.

Source

pub fn signed_area(&self) -> Scalar

Signed area: positive when the edge vectors are counter-clockwise.

Source

pub fn area(&self) -> Scalar

Area, always non-negative. Equals the parallelogram area when sheared.

Source

pub fn center(&self) -> Point2

Centre point.

Trait Implementations§

Source§

impl Clone for Rectangle2

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Rectangle2

Source§

impl Debug for Rectangle2

Source§

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

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

impl PartialEq for Rectangle2

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Rectangle2

Auto Trait Implementations§

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.

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.

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.