#[repr(C)]pub struct Rect<T, U> {
pub origin: Point2D<T, U>,
pub size: Size2D<T, U>,
}
Expand description
A 2d Rectangle optionally tagged with a unit.
§Representation
Rect
is represented by an origin point and a size.
See Box2D
for a rectangle represented by two endpoints.
§Empty rectangle
A rectangle is considered empty (see is_empty
) if any of the following is true:
- it’s area is empty,
- it’s area is negative (
size.x < 0
orsize.y < 0
), - it contains NaNs.
Fields§
§origin: Point2D<T, U>
§size: Size2D<T, U>
Implementations§
source§impl<T, U> Rect<T, U>
impl<T, U> Rect<T, U>
pub fn min(&self) -> Point2D<T, U>
pub fn max(&self) -> Point2D<T, U>
pub fn max_x(&self) -> T
pub fn min_x(&self) -> T
pub fn max_y(&self) -> T
pub fn min_y(&self) -> T
pub fn width(&self) -> T
pub fn height(&self) -> T
pub fn x_range(&self) -> Range<T>
pub fn y_range(&self) -> Range<T>
sourcepub fn translate(&self, by: Vector2D<T, U>) -> Self
pub fn translate(&self, by: Vector2D<T, U>) -> Self
Returns the same rectangle, translated by a vector.
pub fn to_box2d(&self) -> Box2D<T, U>
source§impl<T, U> Rect<T, U>
impl<T, U> Rect<T, U>
sourcepub fn contains_rect(&self, rect: &Self) -> bool
pub fn contains_rect(&self, rect: &Self) -> bool
Returns true
if this rectangle contains the interior of rect
. Always
returns true
if rect
is empty, and always returns false
if rect
is
nonempty but this rectangle is empty.
source§impl<T, U> Rect<T, U>
impl<T, U> Rect<T, U>
sourcepub fn inner_rect(&self, offsets: SideOffsets2D<T, U>) -> Self
pub fn inner_rect(&self, offsets: SideOffsets2D<T, U>) -> Self
Calculate the size and position of an inner rectangle.
Subtracts the side offsets from all sides. The horizontal and vertical offsets must not be larger than the original side length. This method assumes y oriented downward.
source§impl<T, U> Rect<T, U>
impl<T, U> Rect<T, U>
sourcepub fn outer_rect(&self, offsets: SideOffsets2D<T, U>) -> Self
pub fn outer_rect(&self, offsets: SideOffsets2D<T, U>) -> Self
Calculate the size and position of an outer rectangle.
Add the offsets to all sides. The expanded rectangle is returned. This method assumes y oriented downward.
source§impl<T, U> Rect<T, U>
impl<T, U> Rect<T, U>
sourcepub fn from_points<I>(points: I) -> Self
pub fn from_points<I>(points: I) -> Self
Returns the smallest rectangle defined by the top/bottom/left/right-most points provided as parameter.
Note: This function has a behavior that can be surprising because
the right-most and bottom-most points are exactly on the edge
of the rectangle while the contains
function is has exclusive
semantic on these edges. This means that the right-most and bottom-most
points provided to from_points
will count as not contained by the rect.
This behavior may change in the future.
source§impl<T: Copy + Zero + PartialOrd, U> Rect<T, U>
impl<T: Copy + Zero + PartialOrd, U> Rect<T, U>
pub fn to_non_empty(&self) -> Option<Self>
source§impl<T: Copy, U> Rect<T, U>
impl<T: Copy, U> Rect<T, U>
sourcepub fn to_untyped(&self) -> Rect<T, UnknownUnit>
pub fn to_untyped(&self) -> Rect<T, UnknownUnit>
Drop the units, preserving only the numeric value.
sourcepub fn from_untyped(r: &Rect<T, UnknownUnit>) -> Rect<T, U>
pub fn from_untyped(r: &Rect<T, UnknownUnit>) -> Rect<T, U>
Tag a unitless value with units.
source§impl<T: NumCast + Copy, U> Rect<T, U>
impl<T: NumCast + Copy, U> Rect<T, U>
sourcepub fn cast<NewT: NumCast>(&self) -> Rect<NewT, U>
pub fn cast<NewT: NumCast>(&self) -> Rect<NewT, U>
Cast from one numeric representation to another, preserving the units.
When casting from floating point to integer coordinates, the decimals are truncated
as one would expect from a simple cast, but this behavior does not always make sense
geometrically. Consider using round
, round_in
or round_out
before casting.
sourcepub fn try_cast<NewT: NumCast>(&self) -> Option<Rect<NewT, U>>
pub fn try_cast<NewT: NumCast>(&self) -> Option<Rect<NewT, U>>
Fallible cast from one numeric representation to another, preserving the units.
When casting from floating point to integer coordinates, the decimals are truncated
as one would expect from a simple cast, but this behavior does not always make sense
geometrically. Consider using round
, round_in
or [round_out
before casting.
sourcepub fn to_usize(&self) -> Rect<usize, U>
pub fn to_usize(&self) -> Rect<usize, U>
Cast into an usize
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
sourcepub fn to_u32(&self) -> Rect<u32, U>
pub fn to_u32(&self) -> Rect<u32, U>
Cast into an u32
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
sourcepub fn to_u64(&self) -> Rect<u64, U>
pub fn to_u64(&self) -> Rect<u64, U>
Cast into an u64
rectangle, truncating decimals if any.
When casting from floating point rectangles, it is worth considering whether
to round()
, round_in()
or round_out()
before the cast in order to
obtain the desired conversion behavior.
source§impl<T: Floor + Ceil + Round + Add<T, Output = T> + Sub<T, Output = T>, U> Rect<T, U>
impl<T: Floor + Ceil + Round + Add<T, Output = T> + Sub<T, Output = T>, U> Rect<T, U>
sourcepub fn round(&self) -> Self
pub fn round(&self) -> Self
Return a rectangle with edges rounded to integer coordinates, such that the returned rectangle has the same set of pixel centers as the original one. Edges at offset 0.5 round up. Suitable for most places where integral device coordinates are needed, but note that any translation should be applied first to avoid pixel rounding errors. Note that this is not rounding to nearest integer if the values are negative. They are always rounding as floor(n + 0.5).
§Usage notes
Note, that when using with floating-point T
types that method can significantly
lose precision for large values, so if you need to call this method very often it
is better to use Box2D
.
sourcepub fn round_in(&self) -> Self
pub fn round_in(&self) -> Self
Return a rectangle with edges rounded to integer coordinates, such that the original rectangle contains the resulting rectangle.
§Usage notes
Note, that when using with floating-point T
types that method can significantly
lose precision for large values, so if you need to call this method very often it
is better to use Box2D
.
sourcepub fn round_out(&self) -> Self
pub fn round_out(&self) -> Self
Return a rectangle with edges rounded to integer coordinates, such that the original rectangle is contained in the resulting rectangle.
§Usage notes
Note, that when using with floating-point T
types that method can significantly
lose precision for large values, so if you need to call this method very often it
is better to use Box2D
.
Trait Implementations§
source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Rect<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Rect<T, U>
source§fn div_assign(&mut self, scale: Scale<T, U, U>)
fn div_assign(&mut self, scale: Scale<T, U, U>)
/=
operation. Read moresource§impl<T: Copy + DivAssign, U> DivAssign<T> for Rect<T, U>
impl<T: Copy + DivAssign, U> DivAssign<T> for Rect<T, U>
source§fn div_assign(&mut self, scale: T)
fn div_assign(&mut self, scale: T)
/=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Rect<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Rect<T, U>
source§fn mul_assign(&mut self, scale: Scale<T, U, U>)
fn mul_assign(&mut self, scale: Scale<T, U, U>)
*=
operation. Read moresource§impl<T: Copy + MulAssign, U> MulAssign<T> for Rect<T, U>
impl<T: Copy + MulAssign, U> MulAssign<T> for Rect<T, U>
source§fn mul_assign(&mut self, scale: T)
fn mul_assign(&mut self, scale: T)
*=
operation. Read moreimpl<T: Copy, U> Copy for Rect<T, U>
impl<T: Eq, U> Eq for Rect<T, U>
Auto Trait Implementations§
impl<T, U> Freeze for Rect<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Rect<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Rect<T, U>
impl<T, U> Sync for Rect<T, U>
impl<T, U> Unpin for Rect<T, U>
impl<T, U> UnwindSafe for Rect<T, U>where
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)