#[repr(C)]pub struct Box2D<T, U> {
pub min: Point2D<T, U>,
pub max: Point2D<T, U>,
}
Expand description
A 2d axis aligned rectangle represented by its minimum and maximum coordinates.
§Representation
This struct is similar to Rect
, but stores rectangle as two endpoints
instead of origin point and size. Such representation has several advantages over
Rect
representation:
- Several operations are more efficient with
Box2D
, includingintersection
,union
, and point-in-rect. - The representation is less susceptible to overflow. With
Rect
, computation of second point can overflow for a large range of values of origin and size. However, withBox2D
, computation ofsize
cannot overflow if the coordinates are signed and the resulting size is unsigned.
A known disadvantage of Box2D
is that translating the rectangle requires translating
both points, whereas translating Rect
only requires translating one point.
§Empty box
A box is considered empty (see is_empty
) if any of the following is true:
- it’s area is empty,
- it’s area is negative (
min.x > max.x
ormin.y > max.y
), - it contains NaNs.
Fields§
§min: Point2D<T, U>
§max: Point2D<T, U>
Implementations§
Source§impl<T, U> Box2D<T, U>where
T: PartialOrd,
impl<T, U> Box2D<T, U>where
T: PartialOrd,
Sourcepub fn is_negative(&self) -> bool
pub fn is_negative(&self) -> bool
Returns true if the box has a negative area.
The common interpretation for a negative box is to consider it empty. It can be obtained by calculating the intersection of two boxes that do not intersect.
Sourcepub fn intersects(&self, other: &Self) -> bool
pub fn intersects(&self, other: &Self) -> bool
Returns true
if the two boxes intersect.
Sourcepub fn contains(&self, p: Point2D<T, U>) -> bool
pub fn contains(&self, p: Point2D<T, U>) -> bool
Returns true
if this box contains the point. Points are considered
in the box if they are on the front, left or top faces, but outside if they
are on the back, right or bottom faces.
Sourcepub fn contains_box(&self, other: &Self) -> bool
pub fn contains_box(&self, other: &Self) -> bool
Returns true
if this box contains the interior of the other box. Always
returns true
if other is empty, and always returns false
if other is
nonempty but this box is empty.
Source§impl<T, U> Box2D<T, U>where
T: Copy + PartialOrd,
impl<T, U> Box2D<T, U>where
T: Copy + PartialOrd,
pub fn to_non_empty(&self) -> Option<Self>
Sourcepub fn intersection(&self, other: &Self) -> Option<Self>
pub fn intersection(&self, other: &Self) -> Option<Self>
Computes the intersection of two boxes, returning None
if the boxes do not intersect.
Sourcepub fn intersection_unchecked(&self, other: &Self) -> Self
pub fn intersection_unchecked(&self, other: &Self) -> Self
Computes the intersection of two boxes without check whether they do intersect.
The result is a negative box if the boxes do not intersect. This can be useful for computing the intersection of more than two boxes, as it is possible to chain multiple intersection_unchecked calls and check for empty/negative result at the end.
pub fn union(&self, other: &Self) -> Self
Source§impl<T, U> Box2D<T, U>
impl<T, U> Box2D<T, U>
Sourcepub fn inflate(&self, width: T, height: T) -> Self
pub fn inflate(&self, width: T, height: T) -> Self
Inflates the box by the specified sizes on each side respectively.
Sourcepub fn inner_box(&self, offsets: SideOffsets2D<T, U>) -> Self
pub fn inner_box(&self, offsets: SideOffsets2D<T, U>) -> Self
Calculate the size and position of an inner box.
Subtracts the side offsets from all sides. The horizontal, vertical and applicate offsets must not be larger than the original side length.
Sourcepub fn outer_box(&self, offsets: SideOffsets2D<T, U>) -> Self
pub fn outer_box(&self, offsets: SideOffsets2D<T, U>) -> Self
Calculate the b and position of an outer box.
Add the offsets to all sides. The expanded box is returned.
Source§impl<T, U> Box2D<T, U>
impl<T, U> Box2D<T, U>
Sourcepub fn from_size(size: Size2D<T, U>) -> Self
pub fn from_size(size: Size2D<T, U>) -> Self
Creates a Box2D of the given size, at offset zero.
Sourcepub fn from_points<I>(points: I) -> Self
pub fn from_points<I>(points: I) -> Self
Returns the smallest box containing all of the provided points.
Source§impl<T, U> Box2D<T, U>where
T: Copy,
impl<T, U> Box2D<T, U>where
T: Copy,
Sourcepub fn to_untyped(&self) -> Box2D<T, UnknownUnit>
pub fn to_untyped(&self) -> Box2D<T, UnknownUnit>
Drop the units, preserving only the numeric value.
Sourcepub fn from_untyped(c: &Box2D<T, UnknownUnit>) -> Box2D<T, U>
pub fn from_untyped(c: &Box2D<T, UnknownUnit>) -> Box2D<T, U>
Tag a unitless value with units.
pub fn scale<S: Copy>(&self, x: S, y: S) -> Selfwhere
T: Mul<S, Output = T>,
Source§impl<T: NumCast + Copy, U> Box2D<T, U>
impl<T: NumCast + Copy, U> Box2D<T, U>
Sourcepub fn cast<NewT: NumCast>(&self) -> Box2D<NewT, U>
pub fn cast<NewT: NumCast>(&self) -> Box2D<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<Box2D<NewT, U>>
pub fn try_cast<NewT: NumCast>(&self) -> Option<Box2D<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) -> Box2D<usize, U>
pub fn to_usize(&self) -> Box2D<usize, U>
Cast into an usize
box, truncating decimals if any.
When casting from floating point boxes, 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) -> Box2D<u32, U>
pub fn to_u32(&self) -> Box2D<u32, U>
Cast into an u32
box, truncating decimals if any.
When casting from floating point boxes, 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, U> Box2D<T, U>where
T: Round,
impl<T, U> Box2D<T, U>where
T: Round,
Sourcepub fn round(&self) -> Self
pub fn round(&self) -> Self
Return a box with edges rounded to integer coordinates, such that the returned box has the same set of pixel centers as the original one. Values equal to 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).
Trait Implementations§
Source§impl<'de, T, U> Deserialize<'de> for Box2D<T, U>where
T: Deserialize<'de>,
impl<'de, T, U> Deserialize<'de> for Box2D<T, U>where
T: Deserialize<'de>,
Source§fn 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>,
Source§impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<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 Box2D<T, U>
impl<T: Copy + DivAssign, U> DivAssign<T> for Box2D<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 Box2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box2D<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 Box2D<T, U>
impl<T: Copy + MulAssign, U> MulAssign<T> for Box2D<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 Box2D<T, U>
impl<T: Eq, U> Eq for Box2D<T, U>
Auto Trait Implementations§
impl<T, U> Freeze for Box2D<T, U>where
T: Freeze,
impl<T, U> RefUnwindSafe for Box2D<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Box2D<T, U>
impl<T, U> Sync for Box2D<T, U>
impl<T, U> Unpin for Box2D<T, U>
impl<T, U> UnwindSafe for Box2D<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
)