Struct euclid::Rect

#[repr(C)]
pub struct Rect<T, U> {
    pub origin: Point2D<T, U>,
    pub size: Size2D<T, U>,
}

A 2d Rectangle optionally tagged with a unit.

Fields

origin: Point2D<T, U>

size: Size2D<T, U>

Methods

impl<T, U> Rect<T, U>

pub fn new(origin: Point2D<T, U>, size: Size2D<T, U>) -> Self

Constructor.

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

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

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

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

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

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

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

pub fn max_x(&self) -> T

pub fn min_x(&self) -> T

pub fn max_y(&self) -> T

pub fn min_y(&self) -> T

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

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

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

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

Returns the same rectangle, translated by a vector.

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

Returns true if this rectangle contains the point. Points are considered in the rectangle if they are on the left or top edge, but outside if they are on the right or bottom edge.

pub fn contains_rect(&self, rect: &Self) -> bool

Returns true if this rectangle contains the interior of rect. Always returns true if rect is empty, and always returns false if rect is nonempty but this rectangle is empty.

#[must_use] pub fn inflate(&self, width: T, height: T) -> Self

pub fn to_box2d(&self) -> Box2D<T, U>

pub fn inner_rect(&self, offsets: SideOffsets2D<T, U>) -> Self

Calculate the size and position of an inner rectangle.

Subtracts the side offsets from all sides. The horizontal and vertical offsets must not be larger than the original side length. This method assumes y oriented downward.

pub fn outer_rect(&self, offsets: SideOffsets2D<T, U>) -> Self

Calculate the size and position of an outer rectangle.

Add the offsets to all sides. The expanded rectangle is returned. This method assumes y oriented downward.

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

Returns the smallest rectangle defined by the top/bottom/left/right-most points provided as parameter.

Note: This function has a behavior that can be surprising because the right-most and bottom-most points are exactly on the edge of the rectangle while the contains function is has exclusive semantic on these edges. This means that the right-most and bottom-most points provided to from_points will count as not contained by the rect. This behavior may change in the future.

impl<T, U> Rect<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 rectangle and another rectangle.

t is expected to be between zero and one.

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

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

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

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

impl<T, U> Rect<T, U>

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

impl<T: Copy + Clone + Mul<T, Output = T>, U> Rect<T, U>

pub fn area(&self) -> T

impl<T: Copy + PartialEq + Zero, U> Rect<T, U>

pub fn zero() -> Self

Constructor, setting all sides to zero.

pub fn is_empty(&self) -> bool

Returns true if the size is zero, regardless of the origin's value.

impl<T: Copy + Zero + PartialOrd, U> Rect<T, U>

pub fn is_empty_or_negative(&self) -> bool

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

impl<T: Copy, Unit> Rect<T, Unit>

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

Drop the units, preserving only the numeric value.

pub fn from_untyped(r: &Rect<T, UnknownUnit>) -> Rect<T, Unit>

Tag a unitless value with units.

impl<T0: NumCast + Copy, Unit> Rect<T0, Unit>

pub fn cast<T1: NumCast + Copy>(&self) -> Rect<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<Rect<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: Floor + Ceil + Round + Add<T, Output = T> + Sub<T, Output = T>, U> Rect<T, U>

#[must_use] pub fn round(&self) -> Self

Return a rectangle with edges rounded to integer coordinates, such that the returned rectangle has the same set of pixel centers as the original one. Edges at offset 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).

#[must_use] pub fn round_in(&self) -> Self

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

#[must_use] pub fn round_out(&self) -> Self

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

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

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

Cast into an f32 rectangle.

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

Cast into an f64 rectangle.

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

Cast into an usize rectangle, truncating decimals if any.

When casting from floating point rectangles, 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) -> Rect<u32, Unit>

Cast into an u32 rectangle, truncating decimals if any.

When casting from floating point rectangles, 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) -> Rect<i32, Unit>

Cast into an i32 rectangle, truncating decimals if any.

When casting from floating point rectangles, 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) -> Rect<i64, Unit>

Cast into an i64 rectangle, truncating decimals if any.

When casting from floating point rectangles, 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: Display, U> Display for Rect<T, U>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T: PartialEq, U> PartialEq<Rect<T, U>> for Rect<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 Rect<T, U>

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

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Copy + Mul<T, Output = T>, U1, U2> Mul<Scale<T, U1, U2>> for Rect<T, U1>

type Output = Rect<T, U2>

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + Div<T, Output = T>, U1, U2> Div<Scale<T, U1, U2>> for Rect<T, U2>

type Output = Rect<T, U1>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Hash, U> Hash for Rect<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: Copy, U> Copy for Rect<T, U>

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

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

Performs the conversion.

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the "default value" for a type.