Struct Rect

source

#[repr(C)]pub struct Rect {
    pub min: Pos2,
    pub max: Pos2,
}

Expand description

A rectangular region of space.

Usually a Rect has a positive (or zero) size, and then Self::min <= Self::max. In these cases Self::min is the left-top corner and Self::max is the right-bottom corner.

A rectangle is allowed to have a negative size, which happens when the order of min and max are swapped. These are usually a sign of an error.

Normally the unit is points (logical pixels) in screen space coordinates.

Rect does NOT implement Default, because there is no obvious default value. Rect::ZERO may seem reasonable, but when used as a bounding box, Rect::NOTHING is a better default - so be explicit instead!

Fields§

§min: Pos2

One of the corners of the rectangle, usually the left top one.

§max: Pos2

The other corner, opposing Self::min. Usually the right bottom one.

Implementations§

source §

impl Rect

source

pub const EVERYTHING: Self = _

Infinite rectangle that contains every point.

source

pub const NOTHING: Self = _

The inverse of Self::EVERYTHING: stretches from positive infinity to negative infinity. Contains no points.

This is useful as the seed for bounding boxes.

§Example:

let mut rect = Rect::NOTHING;
assert!(rect.size() == Vec2::splat(-f32::INFINITY));
assert!(rect.contains(pos2(0.0, 0.0)) == false);
rect.extend_with(pos2(2.0, 1.0));
rect.extend_with(pos2(0.0, 3.0));
assert_eq!(rect, Rect::from_min_max(pos2(0.0, 1.0), pos2(2.0, 3.0)))

source

pub const NAN: Self = _

An invalid Rect filled with f32::NAN.

source

pub const ZERO: Self = _

A Rect filled with zeroes.

source

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

source

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

left-top corner plus a size (stretching right-down).

source

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

source

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

source

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

Returns the bounding rectangle of the two points.

source

pub fn from_pos(point: Pos2) -> Self

A zero-sized rect at a specific point.

source

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

Bounding-box around the points.

source

pub fn everything_right_of(left_x: f32) -> Self

A Rect that contains every point to the right of the given X coordinate.

source

pub fn everything_left_of(right_x: f32) -> Self

A Rect that contains every point to the left of the given X coordinate.

source

pub fn everything_below(top_y: f32) -> Self

A Rect that contains every point below a certain y coordinate

source

pub fn everything_above(bottom_y: f32) -> Self

A Rect that contains every point above a certain y coordinate

source

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

Expand by this much in each direction, keeping the center

source

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

Expand by this much in each direction, keeping the center

source

pub fn scale_from_center(self, scale_factor: f32) -> Self

Scale up by this factor in each direction, keeping the center

source

pub fn scale_from_center2(self, scale_factor: Vec2) -> Self

Scale up by this factor in each direction, keeping the center

source

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

Shrink by this much in each direction, keeping the center

source

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

Shrink by this much in each direction, keeping the center

source

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

source

pub fn rotate_bb(self, rot: Rot2) -> Self

Rotate the bounds (will expand the Rect)

source

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

source

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

keep min

source

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

keep min

source

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

Keep size

source

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

source

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

source

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

Return the given points clamped to be inside the rectangle Panics if Self::is_negative.

source

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

source

pub fn extend_with_x(&mut self, x: f32)

Expand to include the given x coordinate

source

pub fn extend_with_y(&mut self, y: f32)

Expand to include the given y coordinate

source

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

The union of two bounding rectangle, i.e. the minimum Rect that contains both input rectangles.

source

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

The intersection of two Rect, i.e. the area covered by both.

source

pub fn center(&self) -> Pos2

source

pub fn size(&self) -> Vec2

rect.size() == Vec2 { x: rect.width(), y: rect.height() }

source

pub fn width(&self) -> f32

source

pub fn height(&self) -> f32

source

pub fn aspect_ratio(&self) -> f32

Width / height

aspect_ratio < 1: portrait / high
aspect_ratio = 1: square
aspect_ratio > 1: landscape / wide

source

pub fn square_proportions(&self) -> Vec2

[2, 1] for wide screen, and [1, 2] for portrait, etc. At least one dimension = 1, the other >= 1 Returns the proportions required to letter-box a square view area.

source

pub fn area(&self) -> f32

source

pub fn distance_to_pos(&self, pos: Pos2) -> f32

The distance from the rect to the position.

The distance is zero when the position is in the interior of the rectangle.

Negative rectangles always return f32::INFINITY.

source

pub fn distance_sq_to_pos(&self, pos: Pos2) -> f32

The distance from the rect to the position, squared.

The distance is zero when the position is in the interior of the rectangle.

Negative rectangles always return f32::INFINITY.

source

pub fn signed_distance_to_pos(&self, pos: Pos2) -> f32

Signed distance to the edge of the box.

Negative inside the box.

Negative rectangles always return f32::INFINITY.

let rect = Rect::from_min_max(pos2(0.0, 0.0), pos2(1.0, 1.0));
assert_eq!(rect.signed_distance_to_pos(pos2(0.50, 0.50)), -0.50);
assert_eq!(rect.signed_distance_to_pos(pos2(0.75, 0.50)), -0.25);
assert_eq!(rect.signed_distance_to_pos(pos2(1.50, 0.50)), 0.50);