Struct Rect 

pub struct Rect {
    pub min: Pos2,
    pub max: Pos2,
}

An axis-aligned rectangle, min its left-top corner and max its right-bottom one.

A rect with max < min on either axis is negative: Rect::NOTHING is the deliberate case, the seed a bounding box accumulates from, and Rect::area and the containment tests are written to behave sensibly on it. There is no Default: a zero rect and an empty bounding box are different intentions, so the caller says which.

Fields

min: Pos2

One corner, usually the left-top one.

max: Pos2

The opposing corner, usually the right-bottom one.

Implementations

impl Rect

pub const EVERYTHING: Self

Contains every point.

pub const NOTHING: Self

The inverse of Self::EVERYTHING, containing no point. The seed a bounding box grows from: NOTHING.union(r) == r.

pub const ZERO: Self

pub const fn from_min_max(min: Pos2, max: Pos2) -> Self

pub fn from_min_size(min: Pos2, size: Vec2) -> Self

Left-top corner plus a size, stretching right-down.

pub fn from_center_size(center: Pos2, size: Vec2) -> Self

pub fn from_two_pos(a: Pos2, b: Pos2) -> Self

The bounding rect of the two points, in either order.

pub const fn from_pos(point: Pos2) -> Self

A zero-sized rect at a point.

pub fn from_points(points: &[Pos2]) -> Self

The bounding rect of the points; Self::NOTHING when there are none.

pub fn from_x_y_ranges(x_range: Rangef, y_range: Rangef) -> Self

pub fn expand(self, amnt: f32) -> Self

Grow by amnt on all four sides, keeping the center.

pub fn expand2(self, amnt: Vec2) -> Self

Grow per-axis, keeping the center.

pub fn shrink(self, amnt: f32) -> Self

Shrink by amnt on all four sides, keeping the center.

pub fn shrink2(self, amnt: Vec2) -> Self

Shrink per-axis, keeping the center.

pub fn translate(self, amnt: Vec2) -> Self

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

pub fn set_width(&mut self, w: f32)

Keeps min.

pub fn set_height(&mut self, h: f32)

Keeps min.

pub fn set_center(&mut self, center: Pos2)

Keeps the size.

pub fn contains(&self, p: Pos2) -> bool

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

pub fn clamp(&self, p: Pos2) -> Pos2

p clamped inside the rect.

pub fn extend_with(&mut self, p: Pos2)

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

The smallest rect containing both.

pub fn intersect(self, other: Self) -> Self

The area covered by both. Negative (see Rect) when they are disjoint.

pub fn center(&self) -> Pos2

pub fn size(&self) -> Vec2

pub fn width(&self) -> f32

Can be negative.

pub fn height(&self) -> f32

Can be negative.

pub fn aspect_ratio(&self) -> f32

Width / height: below 1 portrait, above 1 landscape.

pub fn area(&self) -> f32

Zero rather than negative for a negative rect.

pub fn is_negative(&self) -> bool

width < 0 || height < 0

pub fn is_positive(&self) -> bool

width > 0 && height > 0

pub fn is_finite(&self) -> bool

pub fn x_range(&self) -> Rangef

pub fn y_range(&self) -> Rangef

impl Rect

Named edges and corners, assuming the origin is towards left-top.

pub fn left(&self) -> f32

pub fn right(&self) -> f32

pub fn top(&self) -> f32

pub fn bottom(&self) -> f32

pub fn left_top(&self) -> Pos2

pub fn center_top(&self) -> Pos2

pub fn right_top(&self) -> Pos2

pub fn left_center(&self) -> Pos2

pub fn right_center(&self) -> Pos2

pub fn left_bottom(&self) -> Pos2

pub fn center_bottom(&self) -> Pos2

pub fn right_bottom(&self) -> Pos2

Trait Implementations

impl BitOr for Rect

type Output = Rect

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl BitOrAssign for Rect

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for Rect

fn clone(&self) -> Rect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Rect

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

Formats the value using the given formatter.

impl Div<f32> for Rect

type Output = Rect

The resulting type after applying the / operator.

fn div(self, factor: f32) -> Self

Performs the / operation.

impl From<[Pos2; 2]> for Rect

fn from([min, max]: [Pos2; 2]) -> Self

Converts to this type from the input type.

impl Mul<Rect> for f32

type Output = Rect

The resulting type after applying the * operator.

fn mul(self, r: Rect) -> Rect

Performs the * operation.

impl Mul<f32> for Rect

type Output = Rect

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Rect

fn eq(&self, other: &Rect) -> 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 Serialize for Rect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Rect

impl Eq for Rect

impl StructuralPartialEq for Rect