Struct euclid::Box2D [−][src]
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
impl<T, U> Box2D<T, U>
[src]
impl<T, U> Box2D<T, U>
[src]impl<T, U> Box2D<T, U> where
T: PartialOrd,
[src]
impl<T, U> Box2D<T, U> where
T: PartialOrd,
[src]pub fn is_negative(&self) -> bool
[src]
pub fn is_negative(&self) -> bool
[src]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.
pub fn intersects(&self, other: &Self) -> bool
[src]
pub fn intersects(&self, other: &Self) -> bool
[src]Returns true
if the two boxes intersect.
pub fn contains(&self, p: Point2D<T, U>) -> bool
[src]
pub fn contains(&self, p: Point2D<T, U>) -> bool
[src]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.
pub fn contains_box(&self, other: &Self) -> bool
[src]
pub fn contains_box(&self, other: &Self) -> bool
[src]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.
impl<T, U> Box2D<T, U> where
T: Copy + PartialOrd,
[src]
impl<T, U> Box2D<T, U> where
T: Copy + PartialOrd,
[src]pub fn to_non_empty(&self) -> Option<Self>
[src]
pub fn intersection(&self, other: &Self) -> Option<Self>
[src]
pub fn intersection(&self, other: &Self) -> Option<Self>
[src]Computes the intersection of two boxes, returning None
if the boxes do not intersect.
pub fn intersection_unchecked(&self, other: &Self) -> Self
[src]
pub fn intersection_unchecked(&self, other: &Self) -> Self
[src]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.
impl<T, U> Box2D<T, U> where
T: Copy + Add<T, Output = T> + Sub<T, Output = T>,
[src]
impl<T, U> Box2D<T, U> where
T: Copy + Add<T, Output = T> + Sub<T, Output = T>,
[src]#[must_use]pub fn inflate(&self, width: T, height: T) -> Self
[src]
#[must_use]pub fn inflate(&self, width: T, height: T) -> Self
[src]Inflates the box by the specified sizes on each side respectively.
pub fn inner_box(&self, offsets: SideOffsets2D<T, U>) -> Self
[src]
pub fn inner_box(&self, offsets: SideOffsets2D<T, U>) -> Self
[src]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.
pub fn outer_box(&self, offsets: SideOffsets2D<T, U>) -> Self
[src]
pub fn outer_box(&self, offsets: SideOffsets2D<T, U>) -> Self
[src]Calculate the b and position of an outer box.
Add the offsets to all sides. The expanded box is returned.
impl<T, U> Box2D<T, U> where
T: Copy + Zero + PartialOrd,
[src]
impl<T, U> Box2D<T, U> where
T: Copy + Zero + PartialOrd,
[src]pub fn from_points<I>(points: I) -> Self where
I: IntoIterator,
I::Item: Borrow<Point2D<T, U>>,
[src]
pub fn from_points<I>(points: I) -> Self where
I: IntoIterator,
I::Item: Borrow<Point2D<T, U>>,
[src]Returns the smallest box containing all of the provided points.
impl<T, U> Box2D<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]
impl<T, U> Box2D<T, U> where
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
[src]impl<T, U> Box2D<T, U> where
T: Copy,
[src]
impl<T, U> Box2D<T, U> where
T: Copy,
[src]pub fn x_range(&self) -> Range<T>
[src]
pub fn y_range(&self) -> Range<T>
[src]
pub fn to_untyped(&self) -> Box2D<T, UnknownUnit>
[src]
pub fn to_untyped(&self) -> Box2D<T, UnknownUnit>
[src]Drop the units, preserving only the numeric value.
pub fn from_untyped(c: &Box2D<T, UnknownUnit>) -> Box2D<T, U>
[src]
pub fn from_untyped(c: &Box2D<T, UnknownUnit>) -> Box2D<T, U>
[src]Tag a unitless value with units.
pub fn scale<S: Copy>(&self, x: S, y: S) -> Self where
T: Mul<S, Output = T>,
[src]
T: Mul<S, Output = T>,
impl<T: NumCast + Copy, U> Box2D<T, U>
[src]
impl<T: NumCast + Copy, U> Box2D<T, U>
[src]pub fn cast<NewT: NumCast>(&self) -> Box2D<NewT, U>
[src]
pub fn cast<NewT: NumCast>(&self) -> Box2D<NewT, U>
[src]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.
pub fn try_cast<NewT: NumCast>(&self) -> Option<Box2D<NewT, U>>
[src]
pub fn try_cast<NewT: NumCast>(&self) -> Option<Box2D<NewT, U>>
[src]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.
pub fn to_usize(&self) -> Box2D<usize, U>
[src]
pub fn to_usize(&self) -> Box2D<usize, U>
[src]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.
pub fn to_u32(&self) -> Box2D<u32, U>
[src]
pub fn to_u32(&self) -> Box2D<u32, U>
[src]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.
impl<T, U> Box2D<T, U> where
T: Round,
[src]
impl<T, U> Box2D<T, U> where
T: Round,
[src]#[must_use]pub fn round(&self) -> Self
[src]
#[must_use]pub fn round(&self) -> Self
[src]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).
impl<T, U> Box2D<T, U> where
T: Floor + Ceil,
[src]
impl<T, U> Box2D<T, U> where
T: Floor + Ceil,
[src]Trait Implementations
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<Scale<T, U, U>> for Box2D<T, U>
[src]fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn div_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the /=
operation. Read more
impl<T: Copy + DivAssign, U> DivAssign<T> for Box2D<T, U>
[src]
impl<T: Copy + DivAssign, U> DivAssign<T> for Box2D<T, U>
[src]fn div_assign(&mut self, scale: T)
[src]
fn div_assign(&mut self, scale: T)
[src]Performs the /=
operation. Read more
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box2D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<Scale<T, U, U>> for Box2D<T, U>
[src]fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]
fn mul_assign(&mut self, scale: Scale<T, U, U>)
[src]Performs the *=
operation. Read more
impl<T: Copy + MulAssign, U> MulAssign<T> for Box2D<T, U>
[src]
impl<T: Copy + MulAssign, U> MulAssign<T> for Box2D<T, U>
[src]fn mul_assign(&mut self, scale: T)
[src]
fn mul_assign(&mut self, scale: T)
[src]Performs the *=
operation. Read more
impl<T: Copy, U> Copy for Box2D<T, U>
[src]
impl<T: Eq, U> Eq for Box2D<T, U>
[src]
Auto Trait Implementations
impl<T, U> RefUnwindSafe for Box2D<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Box2D<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for Box2D<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> Unpin for Box2D<T, U> where
T: Unpin,
U: Unpin,
T: Unpin,
U: Unpin,
impl<T, U> UnwindSafe for Box2D<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more