Struct figures::SizedRect

pub struct SizedRect<T, Unit> {
    pub origin: Point<T, Unit>,
    pub size: Size<T, Unit>,
}

A rectangle that uses a Point and a Size for representation.

Fields

origin: Point<T, Unit>

The origin of the rectangle.

size: Size<T, Unit>

The size of the rectangle.

Implementations

impl<T, Unit> SizedRect<T, Unit>

pub const fn new(origin: Point<T, Unit>, size: Size<T, Unit>) -> Self

Returns a new rectangle using origin and size.

impl<T, Unit> SizedRect<T, Unit> where
    T: NumCast + Copy, 

pub fn try_cast<NewT: NumCast + Copy>(&self) -> Option<SizedRect<NewT, Unit>>

Attempts to cast T to NewT. If unsuccessful, None is returned.

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

Casts T to NewT.

Panics

Panics if casting fails.

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

pub fn cast_unit<NewUnit>(&self) -> SizedRect<T, NewUnit>

Returns this value with the new unit. Does not affect the underlying value.

impl<T, Unit> SizedRect<T, Unit> where
    T: Ceil + Floor, 

pub fn round_out(self) -> Self

Returns a new rectangle that rounds the origin down using floor and rounds the size out using ceil.

pub fn round_in(self) -> Self

Returns a new rectangle that rounds the origin up using ceil and rounds the size in using floor.

Trait Implementations

impl<T, Unit> AbsDiffEq<SizedRect<T, Unit>> for SizedRect<T, Unit> where
    T: AbsDiffEq<Epsilon = T> + Copy, 

type Epsilon = T::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T, Unit> Approx<T> for SizedRect<T, Unit> where
    T: AbsDiffEq + Copy, 

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

Returns true if the values are approximately equal. Uses approx::AbsDiffEq with the default epsilon.

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

Returns true if the values are not approximately equal. Uses approx::AbsDiffEq with the default epsilon.

impl<T, Unit> Ceil for SizedRect<T, Unit> where
    T: Ceil, 

fn ceil(self) -> Self

Rounds to the smallest integer equal or greater than the original value.

impl<T, Unit> Clone for SizedRect<T, Unit> where
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, Unit> Debug for SizedRect<T, Unit> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T, Unit> Default for SizedRect<T, Unit> where
    T: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<T> Displayable<T> for SizedRect<T, Scaled> where
    T: Div<T, Output = T> + Mul<T, Output = T> + Copy, 

type Pixels = SizedRect<T, Pixels>

The Pixels unit type for this implementor.

type Points = SizedRect<T, Points>

The Points unit type for this implementor.

type Scaled = Self

The Scaled unit type for this implementor.

fn to_pixels(&self, scale: &DisplayScale<T>) -> Self::Pixels

Returns this value after applying scale, if needed.

fn to_points(&self, scale: &DisplayScale<T>) -> Self::Points

Returns this value after applying scale, if needed.

fn to_scaled(&self, _scale: &DisplayScale<T>) -> Self::Scaled

Returns this value after applying scale, if needed.

impl<T> Displayable<T> for SizedRect<T, Points> where
    T: Div<T, Output = T> + Mul<T, Output = T> + Copy, 

type Pixels = SizedRect<T, Pixels>

The Pixels unit type for this implementor.

type Points = Self

The Points unit type for this implementor.

type Scaled = SizedRect<T, Scaled>

The Scaled unit type for this implementor.

fn to_pixels(&self, scale: &DisplayScale<T>) -> Self::Pixels

Returns this value after applying scale, if needed.

fn to_points(&self, _scale: &DisplayScale<T>) -> Self::Points

Returns this value after applying scale, if needed.

fn to_scaled(&self, scale: &DisplayScale<T>) -> Self::Scaled

Returns this value after applying scale, if needed.

impl<T> Displayable<T> for SizedRect<T, Pixels> where
    T: Div<T, Output = T> + Mul<T, Output = T> + Copy, 

type Pixels = Self

The Pixels unit type for this implementor.

type Points = SizedRect<T, Points>

The Points unit type for this implementor.

type Scaled = SizedRect<T, Scaled>

The Scaled unit type for this implementor.

fn to_pixels(&self, _scale: &DisplayScale<T>) -> Self::Pixels

Returns this value after applying scale, if needed.

fn to_points(&self, scale: &DisplayScale<T>) -> Self::Points

Returns this value after applying scale, if needed.

fn to_scaled(&self, scale: &DisplayScale<T>) -> Self::Scaled

Returns this value after applying scale, if needed.

impl<T, UnitA, UnitB> Div<Scale<T, UnitA, UnitB>> for SizedRect<T, UnitB> where
    T: Div<T, Output = T> + Copy, 

type Output = SizedRect<T, UnitA>

The resulting type after applying the / operator.

fn div(self, rhs: Scale<T, UnitA, UnitB>) -> Self::Output

Performs the / operation.

impl<T, Unit> Floor for SizedRect<T, Unit> where
    T: Floor, 

fn floor(self) -> Self

Rounds to the biggest integer equal or lower than the original value.

impl<T: Default, Unit> From<Size<T, Unit>> for SizedRect<T, Unit>

fn from(size: Size<T, Unit>) -> Self

Performs the conversion.

impl<T, Unit> From<SizedRect<T, Unit>> for Rect<T, Unit>

fn from(rect: SizedRect<T, Unit>) -> Self

Performs the conversion.

impl<T, UnitA, UnitB> Mul<Scale<T, UnitA, UnitB>> for SizedRect<T, UnitA> where
    T: Mul<T, Output = T> + Copy, 

type Output = SizedRect<T, UnitB>

The resulting type after applying the * operator.

fn mul(self, rhs: Scale<T, UnitA, UnitB>) -> Self::Output

Performs the * operation.

impl<T, Unit> PartialEq<SizedRect<T, Unit>> for SizedRect<T, Unit> where
    T: PartialEq, 

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

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

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

This method tests for !=.

impl<T, Unit> Rectlike<T, Unit> for SizedRect<T, Unit> where
    T: Zero + PartialOrd + Mul<T, Output = T> + Sub<T, Output = T> + One + Add<T, Output = T> + Div<T, Output = T> + Copy, 

fn as_rect(&self) -> Rect<T, Unit>

Returns this rectangle as a Rect. The rectangle’s underlying data will be unchanged by this operation.

fn as_extents(&self) -> ExtentsRect<T, Unit>

Returns this rectangle converted to an ExtentsRect.

fn as_sized(&self) -> Self

Returns this rectangle converted to a SizedRect.

fn width(&self) -> Figure<T, Unit>

Returns the width of the rectangle.

fn height(&self) -> Figure<T, Unit>

Returns the height of the rectangle.

fn origin(&self) -> Point<T, Unit>

Returns the origin of the rectangle.

fn translate<V: Into<Vector<T, Unit>>>(&self, by: V) -> Self

Moves this rectangle by the vector provided.

fn inflate<V: Into<Vector<T, Unit>>>(&self, by: V) -> Self

Increases the size of this rectangle by the vector provided. The rectangle will grow around its center.

fn to_non_empty(self) -> Option<Self>

Checks to see if this rect is empty. If it is, None is returned. If it isn’t, the rect is returned unmodified.

fn is_empty(&self) -> bool

Returns true if the rect doesn’t have a positive width and height.

fn area(&self) -> Figure<T, Unit>

Returns the area contained by this rectangle.

fn size(&self) -> Size<T, Unit>

Returns the size of the rectangle.

fn center(&self) -> Point<T, Unit>

Returns the center of the rectangle.

fn contains(&self, point: Point<T, Unit>) -> bool

Returns true if point is within this rectangle.

fn intersection<R: Rectlike<T, Unit>>(
    &self,
    other: &R
) -> Option<ExtentsRect<T, Unit>>

Returns the intersecting area between the two rectangles. If the rectangles do not intersect, None is returned.

fn union<R: Rectlike<T, Unit>>(&self, other: &R) -> Option<ExtentsRect<T, Unit>>

Returns the union of the two rectangles. If both rectangles aren’t empty, the smallest rectangle that both rectangles can fit into will be returned. If either rectangle is empty, the other rectangle is returned unmodified.

impl<T, Unit> RelativeEq<SizedRect<T, Unit>> for SizedRect<T, Unit> where
    T: RelativeEq<Epsilon = T> + Copy, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T, Unit> Round for SizedRect<T, Unit> where
    T: Round, 

fn round(self) -> Self

Rounds to the nearest integer value.

impl<T, Unit> UlpsEq<SizedRect<T, Unit>> for SizedRect<T, Unit> where
    T: UlpsEq<Epsilon = T> + Copy, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T, Unit> Copy for SizedRect<T, Unit> where
    T: Copy, 

impl<T, Unit> Eq for SizedRect<T, Unit> where
    T: Eq,