Struct euclid::Box2D

source ·
#[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, including intersection, 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, with Box2D, computation of size 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 or min.y > max.y),
  • it contains NaNs.

Fields§

§min: Point2D<T, U>§max: Point2D<T, U>

Implementations§

source§

impl<T, U> Box2D<T, U>

source

pub const fn new(min: Point2D<T, U>, max: Point2D<T, U>) -> Self

Constructor.

source

pub fn from_origin_and_size(origin: Point2D<T, U>, size: Size2D<T, U>) -> Self
where T: Copy + Add<T, Output = T>,

Constructor.

source

pub fn from_size(size: Size2D<T, U>) -> Self
where T: Zero,

Creates a Box2D of the given size, at offset zero.

source§

impl<T, U> Box2D<T, U>
where T: PartialOrd,

source

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.

source

pub fn is_empty(&self) -> bool

Returns true if the size is zero, negative or NaN.

source

pub fn intersects(&self, other: &Self) -> bool

Returns true if the two boxes intersect.

source

pub fn contains(&self, p: Point2D<T, U>) -> bool

Returns true if this box2d contains the point p. A point is considered in the box2d if it lies on the left or top edges, but outside if it lies on the right or bottom edges.

source

pub fn contains_inclusive(&self, p: Point2D<T, U>) -> bool

Returns true if this box contains the point p. A point is considered in the box2d if it lies on any edge of the box2d.

source

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,

source

pub fn to_non_empty(&self) -> Option<Self>

source

pub fn intersection(&self, other: &Self) -> Option<Self>

Computes the intersection of two boxes, returning None if the boxes do not intersect.

source

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.

source

pub fn union(&self, other: &Self) -> Self

Computes the union of two boxes.

If either of the boxes is empty, the other one is returned.

source§

impl<T, U> Box2D<T, U>
where T: Copy + Add<T, Output = T>,

source

pub fn translate(&self, by: Vector2D<T, U>) -> Self

Returns the same box, translated by a vector.

source§

impl<T, U> Box2D<T, U>
where T: Copy + Sub<T, Output = T>,

source

pub fn size(&self) -> Size2D<T, U>

source

pub fn set_size(&mut self, size: Size2D<T, U>)

Change the size of the box by adjusting the max endpoint without modifying the min endpoint.

source

pub fn width(&self) -> T

source

pub fn height(&self) -> T

source

pub fn to_rect(&self) -> Rect<T, U>

source§

impl<T, U> Box2D<T, U>
where T: Copy + Add<T, Output = T> + Sub<T, Output = T>,

source

pub fn inflate(&self, width: T, height: T) -> Self

Inflates the box by the specified sizes on each side respectively.

source

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.

source

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>
where T: Copy + Zero + PartialOrd,

source

pub fn from_points<I>(points: I) -> Self
where I: IntoIterator, I::Item: Borrow<Point2D<T, U>>,

Returns the smallest box containing all of the provided points.

source§

impl<T, U> Box2D<T, U>
where T: Copy + One + Add<Output = T> + Sub<Output = T> + Mul<Output = T>,

source

pub fn lerp(&self, other: Self, t: T) -> Self

Linearly interpolate between this box and another box.

source§

impl<T, U> Box2D<T, U>
where T: Copy + One + Add<Output = T> + Div<Output = T>,

source

pub fn center(&self) -> Point2D<T, U>

source§

impl<T, U> Box2D<T, U>
where T: Copy + Mul<T, Output = T> + Sub<T, Output = T>,

source

pub fn area(&self) -> T

source§

impl<T, U> Box2D<T, U>
where T: Zero,

source

pub fn zero() -> Self

Constructor, setting all sides to zero.

source§

impl<T, U> Box2D<T, U>
where T: Copy,

source

pub fn x_range(&self) -> Range<T>

source

pub fn y_range(&self) -> Range<T>

source

pub fn to_untyped(&self) -> Box2D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

source

pub fn from_untyped(c: &Box2D<T, UnknownUnit>) -> Box2D<T, U>

Tag a unitless value with units.

source

pub fn cast_unit<V>(&self) -> Box2D<T, V>

Cast the unit

source

pub fn scale<S: Copy>(&self, x: S, y: S) -> Self
where T: Mul<S, Output = T>,

source§

impl<T: NumCast + Copy, U> Box2D<T, U>

source

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.

source

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.

source

pub fn to_f32(&self) -> Box2D<f32, U>

Cast into an f32 box.

source

pub fn to_f64(&self) -> Box2D<f64, U>

Cast into an f64 box.

source

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.

source

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

pub fn to_i32(&self) -> Box2D<i32, U>

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.

source

pub fn to_i64(&self) -> Box2D<i64, U>

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.

source§

impl<T: Float, U> Box2D<T, U>

source

pub fn is_finite(self) -> bool

Returns true if all members are finite.

source§

impl<T, U> Box2D<T, U>
where T: Round,

source

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).

source§

impl<T, U> Box2D<T, U>
where T: Floor + Ceil,

source

pub fn round_in(&self) -> Self

Return a box with faces/edges rounded to integer coordinates, such that the original box contains the resulting box.

source

pub fn round_out(&self) -> Self

Return a box with faces/edges rounded to integer coordinates, such that the original box is contained in the resulting box.

Trait Implementations§

source§

impl<T: Clone, U> Clone for Box2D<T, U>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T: Debug, U> Debug for Box2D<T, U>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: Default, U> Default for Box2D<T, U>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<T: Copy + Div, U1, U2> Div<Scale<T, U1, U2>> for Box2D<T, U2>

source§

type Output = Box2D<<T as Div>::Output, U1>

The resulting type after applying the / operator.
source§

fn div(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the / operation. Read more
source§

impl<T: Copy + Div, U> Div<T> for Box2D<T, U>

source§

type Output = Box2D<<T as Div>::Output, U>

The resulting type after applying the / operator.
source§

fn div(self, scale: T) -> Self::Output

Performs the / operation. Read more
source§

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>)

Performs the /= operation. Read more
source§

impl<T: Copy + DivAssign, U> DivAssign<T> for Box2D<T, U>

source§

fn div_assign(&mut self, scale: T)

Performs the /= operation. Read more
source§

impl<T, U> From<Size2D<T, U>> for Box2D<T, U>
where T: Copy + Zero + PartialOrd,

source§

fn from(b: Size2D<T, U>) -> Self

Converts to this type from the input type.
source§

impl<T: Hash, U> Hash for Box2D<T, U>

source§

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T: Copy + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Box2D<T, U1>

source§

type Output = Box2D<<T as Mul>::Output, U2>

The resulting type after applying the * operator.
source§

fn mul(self, scale: Scale<T, U1, U2>) -> Self::Output

Performs the * operation. Read more
source§

impl<T: Copy + Mul, U> Mul<T> for Box2D<T, U>

source§

type Output = Box2D<<T as Mul>::Output, U>

The resulting type after applying the * operator.
source§

fn mul(self, scale: T) -> Self::Output

Performs the * operation. Read more
source§

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>)

Performs the *= operation. Read more
source§

impl<T: Copy + MulAssign, U> MulAssign<T> for Box2D<T, U>

source§

fn mul_assign(&mut self, scale: T)

Performs the *= operation. Read more
source§

impl<T: PartialEq, U> PartialEq for Box2D<T, U>

source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: Copy, U> Copy for Box2D<T, U>

source§

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>

§

impl<T, U> Send for Box2D<T, U>
where T: Send, U: Send,

§

impl<T, U> Sync for Box2D<T, U>
where T: Sync, U: Sync,

§

impl<T, U> Unpin for Box2D<T, U>
where T: Unpin, U: Unpin,

§

impl<T, U> UnwindSafe for Box2D<T, U>
where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.