Struct TypedRect

#[repr(C)]
pub struct TypedRect<T, U = UnknownUnit> {
    pub origin: TypedPoint2D<T, U>,
    pub size: TypedSize2D<T, U>,
}

A 2d Rectangle optionally tagged with a unit.

Fields

origin: TypedPoint2D<T, U>

size: TypedSize2D<T, U>

Implementations

impl<T, U> TypedRect<T, U>

pub fn new( origin: TypedPoint2D<T, U>, size: TypedSize2D<T, U>, ) -> TypedRect<T, U>

Constructor.

impl<T, U> TypedRect<T, U>

where T: Copy + Zero,

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

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

impl<T, U> TypedRect<T, U>

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

pub fn intersects(&self, other: &TypedRect<T, U>) -> bool

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 max_x_typed(&self) -> Length<T, U>

pub fn min_x_typed(&self) -> Length<T, U>

pub fn max_y_typed(&self) -> Length<T, U>

pub fn min_y_typed(&self) -> Length<T, U>

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

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

pub fn intersection(&self, other: &TypedRect<T, U>) -> Option<TypedRect<T, U>>

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

Returns the same rectangle, translated by a vector.

pub fn contains(&self, other: &TypedPoint2D<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: &TypedRect<T, U>) -> 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.

pub fn inflate(&self, width: T, height: T) -> TypedRect<T, U>

pub fn inflate_typed( &self, width: Length<T, U>, height: Length<T, U>, ) -> TypedRect<T, U>

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

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

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

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

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

pub fn inner_rect(&self, offsets: TypedSideOffsets2D<T, U>) -> TypedRect<T, U>

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.

pub fn outer_rect(&self, offsets: TypedSideOffsets2D<T, U>) -> TypedRect<T, U>

Calculate the size and position of an outer rectangle.

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

pub fn from_points<I>(points: I) -> TypedRect<T, U>

where I: IntoIterator, <I as IntoIterator>::Item: Borrow<TypedPoint2D<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> TypedRect<T, U>

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

pub fn lerp(&self, other: TypedRect<T, U>, t: T) -> TypedRect<T, U>

Linearly interpolate between this rectangle and another rectangle.

t is expected to be between zero and one.

impl<T, U> TypedRect<T, U>

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

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

impl<T, U> TypedRect<T, U>

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

pub fn union(&self, other: &TypedRect<T, U>) -> TypedRect<T, U>

impl<T, U> TypedRect<T, U>

pub fn scale<S>(&self, x: S, y: S) -> TypedRect<T, U>

where S: Copy, T: Copy + Clone + Mul<S, Output = T>,

impl<T, U> TypedRect<T, U>

where T: Copy + Clone + Mul<Output = T>,

pub fn area(&self) -> T

impl<T, U> TypedRect<T, U>

where T: Copy + PartialEq + Zero,

pub fn zero() -> TypedRect<T, U>

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, Unit> TypedRect<T, Unit>

where T: Copy,

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

Drop the units, preserving only the numeric value.

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

Tag a unitless value with units.

impl<T0, Unit> TypedRect<T0, Unit>

where T0: NumCast + Copy,

pub fn cast<T1>(&self) -> TypedRect<T1, Unit>

where T1: NumCast + Copy,

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>(&self) -> Option<TypedRect<T1, Unit>>

where T1: NumCast + Copy,

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> TypedRect<T, U>

where T: Floor + Ceil + Round + Add<Output = T> + Sub<Output = T>,

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

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

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

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

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

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

impl<T, Unit> TypedRect<T, Unit>

where T: NumCast + Copy,

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

Cast into an f32 rectangle.

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

Cast into an f64 rectangle.

pub fn to_usize(&self) -> TypedRect<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) -> TypedRect<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) -> TypedRect<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) -> TypedRect<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, U> Clone for TypedRect<T, U>

where T: Copy,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for TypedRect<T, U>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, U> Default for TypedRect<T, U>

where T: Default,

fn default() -> TypedRect<T, U>

Returns the “default value” for a type.

impl<T, U> Display for TypedRect<T, U>

where T: Display,

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

Formats the value using the given formatter.

impl<T, U> Div<T> for TypedRect<T, U>

where T: Copy + Div<Output = T>,

type Output = TypedRect<T, U>

The resulting type after applying the / operator.

fn div(self, scale: T) -> TypedRect<T, U>

Performs the / operation.

impl<T, U1, U2> Div<TypedScale<T, U1, U2>> for TypedRect<T, U2>

where T: Copy + Div<Output = T>,

type Output = TypedRect<T, U1>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'l> From<&'l TypedRect<f32>> for Variant

fn from(val: &'l TypedRect<f32>) -> Variant

Converts to this type from the input type.

impl<T, U> From<TypedSize2D<T, U>> for TypedRect<T, U>

where T: Copy + Zero,

fn from(size: TypedSize2D<T, U>) -> TypedRect<T, U>

Converts to this type from the input type.

impl<T, U> Hash for TypedRect<T, U>

where T: Hash,

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U> Mul<T> for TypedRect<T, U>

where T: Copy + Mul<Output = T>,

type Output = TypedRect<T, U>

The resulting type after applying the * operator.

fn mul(self, scale: T) -> TypedRect<T, U>

Performs the * operation.

impl<T, U1, U2> Mul<TypedScale<T, U1, U2>> for TypedRect<T, U1>

where T: Copy + Mul<Output = T>,

type Output = TypedRect<T, U2>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U> PartialEq for TypedRect<T, U>

where T: PartialEq,

fn eq(&self, other: &TypedRect<T, U>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, U> Copy for TypedRect<T, U>

where T: Copy,

impl<T, U> Eq for TypedRect<T, U>

where T: Eq,