Struct Rect

pub struct Rect {
    pub x_min: f32,
    pub y_min: f32,
    pub x_max: f32,
    pub y_max: f32,
}

Axis-aligned rectangle

Fields

x_min: f32

y_min: f32

x_max: f32

y_max: f32

Implementations

impl Rect

pub const QUADRANT_NEIGHBOR_LAYOUT: [[usize; 2]; 4]

For all quadrants, contains indices of the two neighbors of the quadrant at that index.

pub fn try_new(x_min: f32, y_min: f32, x_max: f32, y_max: f32) -> Result<Self>

pub fn from_diagonal_corners(c1: Point, c2: Point) -> Result<Self>

pub fn relation_to(&self, other: Rect) -> GeoRelation

Returns the geometric relation between self and another Rect.

pub fn almost_relation_to(&self, other: Rect) -> GeoRelation

Returns the GeoRelation between self and another Rect, with a tolerance for floating point precision. In edge cases, this method will lean towards Surrounding and Enclosed instead of Intersecting.

pub fn inflate_to_square(&self) -> Rect

Returns a new rectangle with the same centroid but inflated to be the minimum square that contains self.

pub fn scale(self, factor: f32) -> Self

Returns a new rectangle with the same centroid but scaled by factor.

pub fn resize_by(self, dx: f32, dy: f32) -> Option<Self>

Returns a new rectangle with the same centroid as self but expanded by dx in both x-directions and by dy in both y-directions. If the new rectangle is invalid (x_min >= x_max or y_min >= y_max), returns None.

pub fn quadrants(&self) -> [Self; 4]

Returns the 4 quadrants of self. Ordered in the same way as quadrants in a cartesian plane: https://en.wikipedia.org/wiki/Quadrant_(plane_geometry)

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

Returns the four corners of self, in the same order as Rect::quadrants.

pub fn edges(&self) -> [Edge; 4]

Returns the four edges that make up self, in the same order as Rect::quadrants.

pub fn width(&self) -> f32

pub fn height(&self) -> f32

pub fn intersection(a: Rect, b: Rect) -> Option<Rect>

Returns the largest rectangle that is contained in both a and b.

pub fn bounding_rect(a: Rect, b: Rect) -> Rect

Returns the smallest rectangle that contains both a and b.

pub fn centroid(&self) -> Point

pub fn area(&self) -> f32

pub fn diameter(&self) -> f32

Trait Implementations

impl AlmostCollidesWith<Point> for Rect

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

impl AlmostCollidesWith<Rect> for Rect

fn almost_collides_with(&self, other: &Rect) -> bool

impl Clone for Rect

fn clone(&self) -> Rect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CollidesWith<Edge> for Rect

fn collides_with(&self, edge: &Edge) -> bool

impl CollidesWith<Point> for Rect

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

impl CollidesWith<Rect> for Circle

fn collides_with(&self, rect: &Rect) -> bool

impl CollidesWith<Rect> for Edge

fn collides_with(&self, other: &Rect) -> bool

impl CollidesWith<Rect> for Rect

fn collides_with(&self, other: &Rect) -> bool

impl Debug for Rect

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

Formats the value using the given formatter.

impl DistanceTo<Point> for Rect

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

Minimum distance between two primitives. Will be 0 in case of a collision.

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

Squared version of DistanceTo::distance_to

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 SeparationDistance<Point> for Rect

fn separation_distance(&self, point: &Point) -> (GeoPosition, f32)

In case of a collision between self and other, returns GeoPosition::Interior and the minimum distance to separate the two primitives. Otherwise, returns GeoPosition::Exterior and the minimum distance between the two primitives. (similar to DistanceTo::distance_to)

fn sq_separation_distance(&self, point: &Point) -> (GeoPosition, f32)

Squared version of SeparationDistance::separation_distance

impl Copy for Rect

impl StructuralPartialEq for Rect