Struct euclid::TypedBox2D

#[repr(C)]
pub struct TypedBox2D<T, U> {
    pub min: TypedPoint2D<T, U>,
    pub max: TypedPoint2D<T, U>,
}

An axis aligned rectangle represented by its minimum and maximum coordinates.

Fields

min: TypedPoint2D<T, U>

max: TypedPoint2D<T, U>

Methods

impl<T, U> TypedBox2D<T, U>

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

Constructor.

impl<T, U> TypedBox2D<T, U> where
    T: Copy + Zero + PartialOrd, 

pub fn from_size(size: TypedSize2D<T, U>) -> Self

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

impl<T, U> TypedBox2D<T, U> where
    T: Copy + PartialOrd, 

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.

pub fn is_empty_or_negative(&self) -> bool

Returns true if the size is zero or negative.

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

Returns true if the two boxes intersect.

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

Computes the intersection of two boxes.

The result is a negative box if the boxes do not intersect.

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

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

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

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

Returns the same box, translated by a vector.

impl<T, U> TypedBox2D<T, U> where
    T: Copy + PartialOrd + Zero, 

pub fn contains(&self, p: &TypedPoint2D<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.

impl<T, U> TypedBox2D<T, U> where
    T: Copy + PartialOrd + Zero + Sub<T, Output = T>, 

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.

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

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

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

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

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

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

impl<T, U> TypedBox2D<T, U> where
    T: Copy + Zero + PartialOrd + Add<T, Output = T> + Sub<T, Output = T>, 

pub fn inner_box(&self, offsets: TypedSideOffsets2D<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.

pub fn outer_box(&self, offsets: TypedSideOffsets2D<T, U>) -> Self

Calculate the b and position of an outer box.

Add the offsets to all sides. The expanded box is returned.

impl<T, U> TypedBox2D<T, U> where
    T: Copy + Zero + PartialOrd, 

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

Returns the smallest box containing all of the provided points.

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

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

Linearly interpolate between this box and another box.

t is expected to be between zero and one.

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

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

impl<T, U> TypedBox2D<T, U> where
    T: Copy + PartialOrd, 

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

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

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

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

pub fn area(&self) -> T

impl<T, U> TypedBox2D<T, U> where
    T: Copy + Zero, 

pub fn zero() -> Self

Constructor, setting all sides to zero.

impl<T, U> TypedBox2D<T, U> where
    T: PartialEq, 

pub fn is_empty(&self) -> bool

Returns true if the size is zero.

impl<T, Unit> TypedBox2D<T, Unit> where
    T: Copy, 

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

Drop the units, preserving only the numeric value.

pub fn from_untyped(c: &Box2D<T>) -> TypedBox2D<T, Unit>

Tag a unitless value with units.

impl<T0, Unit> TypedBox2D<T0, Unit> where
    T0: NumCast + Copy, 

pub fn cast<T1: NumCast + Copy>(&self) -> TypedBox2D<T1, Unit>

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<T1: NumCast + Copy>(&self) -> Option<TypedBox2D<T1, Unit>>

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.

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

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

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

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.

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.

impl<T: NumCast + Copy, Unit> TypedBox2D<T, Unit>

pub fn to_f32(&self) -> TypedBox2D<f32, Unit>

Cast into an f32 box.

pub fn to_f64(&self) -> TypedBox2D<f64, Unit>

Cast into an f64 box.

pub fn to_usize(&self) -> TypedBox2D<usize, Unit>

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) -> TypedBox2D<u32, Unit>

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) -> TypedBox2D<i32, Unit>

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) -> TypedBox2D<i64, Unit>

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.

Trait Implementations

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Eq, U> Eq for TypedBox2D<T, U>

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

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T: Display, U> Display for TypedBox2D<T, U>

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T, U> Mul<T> for TypedBox2D<T, U> where
    T: Copy + Mul<T, Output = T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedBox2D<T, U1> where
    T: Copy + Mul<T, Output = T>, 

type Output = TypedBox2D<T, U2>

The resulting type after applying the * operator.

fn mul(self, scale: TypedScale<T, U1, U2>) -> TypedBox2D<T, U2>

Performs the * operation.

impl<T, U> Div<T> for TypedBox2D<T, U> where
    T: Copy + Div<T, Output = T>, 

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U1, U2> Div<TypedScale<T, U1, U2>> for TypedBox2D<T, U2> where
    T: Copy + Div<T, Output = T>, 

type Output = TypedBox2D<T, U1>

The resulting type after applying the / operator.

fn div(self, scale: TypedScale<T, U1, U2>) -> TypedBox2D<T, U1>

Performs the / operation.

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

impl<T, U> From<TypedSize2D<T, U>> for TypedBox2D<T, U> where
    T: Copy + Zero + PartialOrd, 

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

Performs the conversion.

impl<T: Copy, U> Clone for TypedBox2D<T, U>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.