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.
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
sourceimpl Rect
impl Rect
sourcepub const EVERYTHING: Self
pub const EVERYTHING: Self
Infinite rectangle that contains every point.
sourcepub const NOTHING: Self
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)))
pub const fn from_min_max(min: Pos2, max: Pos2) -> Self
sourcepub fn from_min_size(min: Pos2, size: Vec2) -> 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_x_y_ranges(
x_range: RangeInclusive<f32>,
y_range: RangeInclusive<f32>
) -> Self
sourcepub fn from_two_pos(a: Pos2, b: Pos2) -> Self
pub fn from_two_pos(a: Pos2, b: Pos2) -> Self
Returns the bounding rectangle of the two points.
sourcepub fn from_points(points: &[Pos2]) -> Self
pub fn from_points(points: &[Pos2]) -> Self
Bounding-box around the points.
sourcepub fn everything_right_of(left_x: f32) -> Self
pub fn everything_right_of(left_x: f32) -> Self
A Rect
that contains every point to the right of the given X coordinate.
sourcepub fn everything_left_of(right_x: f32) -> Self
pub fn everything_left_of(right_x: f32) -> Self
A Rect
that contains every point to the left of the given X coordinate.
sourcepub fn everything_below(top_y: f32) -> Self
pub fn everything_below(top_y: f32) -> Self
A Rect
that contains every point below a certain y coordinate
sourcepub fn everything_above(bottom_y: f32) -> Self
pub fn everything_above(bottom_y: f32) -> Self
A Rect
that contains every point above a certain y coordinate
sourcepub fn expand(self, amnt: f32) -> Self
pub fn expand(self, amnt: f32) -> Self
Expand by this much in each direction, keeping the center
sourcepub fn expand2(self, amnt: Vec2) -> Self
pub fn expand2(self, amnt: Vec2) -> Self
Expand by this much in each direction, keeping the center
sourcepub fn shrink(self, amnt: f32) -> Self
pub fn shrink(self, amnt: f32) -> Self
Shrink by this much in each direction, keeping the center
sourcepub fn shrink2(self, amnt: Vec2) -> Self
pub fn shrink2(self, amnt: Vec2) -> Self
Shrink by this much in each direction, keeping the center
pub fn translate(self, amnt: Vec2) -> Self
pub fn intersects(self, other: Rect) -> bool
sourcepub fn set_height(&mut self, h: f32)
pub fn set_height(&mut self, h: f32)
keep min
sourcepub fn set_center(&mut self, center: Pos2)
pub fn set_center(&mut self, center: Pos2)
Keep size
pub fn contains(&self, p: Pos2) -> bool
pub fn contains_rect(&self, other: Rect) -> bool
sourcepub fn clamp(&self, p: Pos2) -> Pos2
pub fn clamp(&self, p: Pos2) -> Pos2
Return the given points clamped to be inside the rectangle
Panics if Self::is_negative
.
pub fn extend_with(&mut self, p: Pos2)
sourcepub fn extend_with_x(&mut self, x: f32)
pub fn extend_with_x(&mut self, x: f32)
Expand to include the given x coordinate
sourcepub fn extend_with_y(&mut self, y: f32)
pub fn extend_with_y(&mut self, y: f32)
Expand to include the given y coordinate
sourcepub fn union(self, other: Rect) -> Rect
pub fn union(self, other: Rect) -> Rect
The union of two bounding rectangle, i.e. the minimum Rect
that contains both input rectangles.
sourcepub fn intersect(self, other: Rect) -> Self
pub fn intersect(self, other: Rect) -> Self
The intersection of two Rect
, i.e. the area covered by both.
pub fn center(&self) -> Pos2
pub fn size(&self) -> Vec2
pub fn width(&self) -> f32
pub fn height(&self) -> f32
sourcepub fn aspect_ratio(&self) -> f32
pub fn aspect_ratio(&self) -> f32
Width / height
aspect_ratio < 1
: portrait / highaspect_ratio = 1
: squareaspect_ratio > 1
: landscape / wide
sourcepub fn square_proportions(&self) -> Vec2
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.
pub fn area(&self) -> f32
pub fn distance_sq_to_pos(&self, pos: Pos2) -> f32
pub fn x_range(&self) -> RangeInclusive<f32>
pub fn y_range(&self) -> RangeInclusive<f32>
pub fn bottom_up_range(&self) -> RangeInclusive<f32>
sourcepub fn is_negative(&self) -> bool
pub fn is_negative(&self) -> bool
width < 0 || height < 0
sourcepub fn is_positive(&self) -> bool
pub fn is_positive(&self) -> bool
width > 0 && height > 0
sourceimpl Rect
impl Rect
sourcepub fn bottom_mut(&mut self) -> &mut f32
pub fn bottom_mut(&mut self) -> &mut f32
max.y
sourcepub fn set_bottom(&mut self, y: f32)
pub fn set_bottom(&mut self, y: f32)
max.y
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
sourceimpl<'de> Deserialize<'de> for Rect
impl<'de> Deserialize<'de> for Rect
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Copy for Rect
impl Eq for Rect
impl Pod for Rect
impl StructuralEq for Rect
impl StructuralPartialEq for Rect
Auto Trait Implementations
impl RefUnwindSafe for Rect
impl Send for Rect
impl Sync for Rect
impl Unpin for Rect
impl UnwindSafe for Rect
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more