Struct euclid::Box2D [−][src]
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> where
T: PartialOrd,
[src]
T: PartialOrd,
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 is_empty(&self) -> bool
[src]
Returns true if the size is zero, negative or NaN.
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]
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]
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]
T: Copy + PartialOrd,
pub fn to_non_empty(&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]
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
[src]
impl<T, U> Box2D<T, U> where
T: Copy + Add<T, Output = T>,
[src]
T: Copy + Add<T, Output = T>,
pub fn translate(&self, by: Vector2D<T, U>) -> Self
[src]
Returns the same box, translated by a vector.
impl<T, U> Box2D<T, U> where
T: Copy + Sub<T, Output = T>,
[src]
T: Copy + Sub<T, Output = T>,
pub fn size(&self) -> Size2D<T, U>
[src]
pub fn width(&self) -> T
[src]
pub fn height(&self) -> T
[src]
pub fn to_rect(&self) -> Rect<T, U>
[src]
impl<T, U> Box2D<T, U> where
T: Copy + Add<T, Output = T> + Sub<T, Output = T>,
[src]
T: Copy + Add<T, Output = T> + Sub<T, Output = T>,
#[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]
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]
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]
T: Copy + Zero + PartialOrd,
pub fn from_size(size: Size2D<T, U>) -> Self
[src]
Creates a Box2D of the given size, at offset zero.
pub fn from_points<I>(points: I) -> Self where
I: IntoIterator,
I::Item: Borrow<Point2D<T, U>>,
[src]
I: IntoIterator,
I::Item: Borrow<Point2D<T, U>>,
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]
T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,
pub fn lerp(&self, other: Self, t: T) -> Self
[src]
Linearly interpolate between this box and another box.
impl<T, U> Box2D<T, U> where
T: Copy + One + Add<Output = T> + Div<Output = T>,
[src]
T: Copy + One + Add<Output = T> + Div<Output = T>,
impl<T, U> Box2D<T, U> where
T: Copy + Mul<T, Output = T> + Sub<T, Output = T>,
[src]
T: Copy + Mul<T, Output = T> + Sub<T, Output = T>,
impl<T, U> Box2D<T, U> where
T: Zero,
[src]
T: Zero,
impl<T, U> Box2D<T, U> where
T: Copy,
[src]
T: Copy,
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]
Tag a unitless value with units.
pub fn cast_unit<V>(&self) -> Box2D<T, V>
[src]
Cast the unit
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]
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]
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_f32(&self) -> Box2D<f32, U>
[src]
Cast into an f32
box.
pub fn to_f64(&self) -> Box2D<f64, U>
[src]
Cast into an f64
box.
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]
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.
pub fn to_i32(&self) -> Box2D<i32, U>
[src]
Cast into an i32
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_i64(&self) -> Box2D<i64, U>
[src]
Cast into an i64
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]
T: Round,
#[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]
T: Floor + Ceil,
#[must_use]pub fn round_in(&self) -> Self
[src]
Return a box with faces/edges rounded to integer coordinates, such that the original box contains the resulting box.
#[must_use]pub fn round_out(&self) -> Self
[src]
Return a box with faces/edges rounded to integer coordinates, such that the original box is contained in the resulting box.
Trait Implementations
impl<T: Clone, U> Clone for Box2D<T, U>
[src]
fn clone(&self) -> Self
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Copy, U> Copy for Box2D<T, U>
[src]
impl<T: Debug, U> Debug for Box2D<T, U>
[src]
impl<T: Copy + Div, U1, U2> Div<Scale<T, U1, U2>> for Box2D<T, U2>
[src]
type Output = Box2D<T::Output, U1>
The resulting type after applying the /
operator.
fn div(self, scale: Scale<T, U1, U2>) -> Self::Output
[src]
impl<T: Copy + Div, U> Div<T> for Box2D<T, U>
[src]
type Output = Box2D<T::Output, U>
The resulting type after applying the /
operator.
fn div(self, scale: T) -> Self::Output
[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]
impl<T: Copy + DivAssign, U> DivAssign<T> for Box2D<T, U>
[src]
fn div_assign(&mut self, scale: T)
[src]
impl<T: Eq, U> Eq for Box2D<T, U>
[src]
impl<T, U> From<Size2D<T, U>> for Box2D<T, U> where
T: Copy + Zero + PartialOrd,
[src]
T: Copy + Zero + PartialOrd,
impl<T: Hash, U> Hash for Box2D<T, U>
[src]
fn hash<H: Hasher>(&self, h: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: Copy + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Box2D<T, U1>
[src]
type Output = Box2D<T::Output, U2>
The resulting type after applying the *
operator.
fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output
[src]
impl<T: Copy + Mul, U> Mul<T> for Box2D<T, U>
[src]
type Output = Box2D<T::Output, U>
The resulting type after applying the *
operator.
fn mul(self, scale: T) -> Self::Output
[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]
impl<T: Copy + MulAssign, U> MulAssign<T> for Box2D<T, U>
[src]
fn mul_assign(&mut self, scale: T)
[src]
impl<T: PartialEq, U> PartialEq<Box2D<T, U>> 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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,