Struct glamour::Rect

#[repr(C)]
pub struct Rect<T: Unit = f32> {
    pub origin: Point2<T>,
    pub size: Size2<T>,
}

2D axis-aligned rectangle represented as “origin” and “size”.

Fields

origin: Point2<T>

Lower bound of the rect.

size: Size2<T>

Size of the rect.

Implementations

impl<T: Unit> Rect<T>

pub const ZERO: Self = _

Zero rect (origin = 0.0, size = 0.0).

pub fn new(origin: impl Into<Point2<T>>, size: impl Into<Size2<T>>) -> Rect<T>

New Rect from origin/size.

pub fn from_untyped(untyped: Rect<T::Scalar>) -> Rect<T>

Bitcast an untyped instance to self.

pub fn to_untyped(self) -> Rect<T::Scalar>

Bitcast self to an untyped instance.

pub fn as_untyped(&self) -> &Rect<T::Scalar>

Reinterpret cast self as the untyped variant.

pub fn as_untyped_mut(&mut self) -> &mut Rect<T::Scalar>

Reinterpret cast self as the untyped variant.

pub fn cast<T2>(self) -> Rect<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn cast_ref<T2>(&self) -> &Rect<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn cast_mut<T2>(&mut self) -> &mut Rect<T2>

where T2: Unit<Scalar = T::Scalar>,

Cast to a different coordinate space with the same underlying scalar type.

pub fn try_cast<T2>(self) -> Option<Rect<T2>>

where T2: Unit,

Cast to a different coordinate space with scalar type conversion. Returns None if any component could not be converted to the target scalar type.

pub const fn from_tuple((origin, size): (Point2<T>, Size2<T>)) -> Self

Instantiate from tuple.

pub const fn to_tuple(self) -> (Point2<T>, Size2<T>)

Convert to tuple.

pub const fn from_size(size: Size2<T>) -> Self

Rect at (0.0, 0.0) with size.

pub fn from_box(b: Box2<T>) -> Self

Create from Box2.

Note: This may lose precision due to floating point arithmetic.

pub fn from_min_max(min: Point2<T>, max: Point2<T>) -> Self

Create from min/max points.

pub fn from_points<I>(points: I) -> Self

where I: IntoIterator<Item = Point2<T>>,

Calculate the bounding rect that covers all points.

pub const fn min(&self) -> Point2<T>

Get rect lower bound (origin).

pub fn max(&self) -> Point2<T>

Get rect upper bound (origin + size).

pub const fn width(&self) -> T::Scalar

Width of the rectangle.

pub const fn height(&self) -> T::Scalar

Height of the rectangle.

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

Range of X coordinates covered by this rectangle.

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

Range of Y coordinates covered by this rectangle.

pub fn corners(&self) -> [Point2<T>; 4]

Corners of the rectangle, clockwise from top left.

pub fn center(&self) -> Point2<T>

Get the point at the center of the rect.

pub fn translate(self, by: Vector2<T>) -> Self

Translate a copy of the rect by vector.

pub fn inflate(&self, by: Size2<T>) -> Self

Increase the size of the rect by moving the origin back by the size, and increasing the size of the rectangle by 2 * by.

Example

let r = Rect::<f32>::new((10.0, 10.0), (10.0, 10.0));
let r = r.inflate((10.0, 10.0).into());
assert_eq!(r.origin, (0.0, 0.0));
assert_eq!(r.size, (30.0, 30.0));

pub fn to_box2(&self) -> Box2<T>

Convert to Box2.

pub fn area(&self) -> T::Scalar

Get the area of the rect (equivalent to self.size.area()).

pub fn is_empty(&self) -> bool

True if size is zero or negative or NaN.

pub fn is_negative(&self) -> bool

True if size is negative or NaN.

impl<T> Rect<T>

where T: Unit, T::Scalar: FloatScalar,

pub fn is_finite(&self) -> bool

True if the rect only contains finite and non-NaN coordinates.

pub fn round(self) -> Self

Round all coordinates.

Note: This may create an empty rect from a non-empty rect.

Example

let r = Rect::<f32>::new((0.51, 0.49), (0.51, 0.49));
let r = r.round();
assert_eq!(r, Rect::<f32>::new((1.0, 0.0), (1.0, 0.0)));

pub fn round_in(self) -> Self

Round all coordinates towards the center of the rect.

This function needs to convert the rect to a Box2 before rounding, which loses both performance and precision. Use Box2 if you need to perform this operation frequently.

Note: This may create an empty rect from a non-empty rect.

Example

let r = Rect::<f32>::new((0.51, 0.49), (1.51, 1.49));
let r = r.round_in();
assert_eq!(r, Rect::<f32>::new((1.0, 1.0), (1.0, 0.0)));

pub fn round_out(self) -> Self

Round all coordinates away from the center of the rect.

This function needs to convert the rect to a Box2 before rounding, which loses both performance and precision. Use Box2 if you need to perform this operation frequently.

Note: As opposed to Rect::round() and Rect::round_in(), this will not create an empty rect from a non-empty rect.

Example

let r = Rect::<f32>::new((0.51, 0.49), (1.51, 1.49));
let r = r.round_out();
assert_eq!(r, Rect::new((0.0, 0.0), (3.0, 2.0)));

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

Linear interpolation between two rects.

Trait Implementations

impl<T> AbsDiffEq<(Point2<T>, Size2<T>)> for Rect<T>

where T: Unit, T::Scalar: AbsDiffEq, <T::Scalar as AbsDiffEq>::Epsilon: Copy,

type Epsilon = <<T as Unit>::Scalar as AbsDiffEq>::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: &(Point2<T>, Size2<T>), 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: &(Point2<T>, Size2<T>), epsilon: Self::Epsilon ) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Unit> AbsDiffEq for Rect<T>

type Epsilon = <<T as Unit>::Scalar as AbsDiffEq>::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> Clone for Rect<T>

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> Contains<Point2<T>> for Rect<T>

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

Returns true if thing is inside self.

impl<T: Unit> Debug for Rect<T>

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

Formats the value using the given formatter.

impl<T: Unit> Default for Rect<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Unit> From<(Point2<T>, Size2<T>)> for Rect<T>

fn from(tuple: (Point2<T>, Size2<T>)) -> Rect<T>

Converts to this type from the input type.

impl<T: Unit> From<Box2<T>> for Rect<T>

fn from(x: Box2<T>) -> Self

Converts to this type from the input type.

impl<T: Unit> From<Rect<T>> for (Point2<T>, Size2<T>)

fn from(value: Rect<T>) -> (Point2<T>, Size2<T>)

Converts to this type from the input type.

impl<T: Unit> From<Rect<T>> for Box2<T>

fn from(x: Rect<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for Rect<T>

where T: Unit, T::Scalar: Hash,

fn hash<H>(&self, state: &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: Unit> Intersection<Box2<T>> for Rect<T>

type Intersection = Rect<T>

The type of intersection.

fn intersects(&self, thing: &Box2<T>) -> bool

True if thing intersects with self.

fn intersection(&self, thing: &Box2<T>) -> Option<Self::Intersection>

If thing intersects with self, return the intersection. Otherwise, returns None.

impl<T: Unit> Intersection<Point2<T>> for Rect<T>

type Intersection = Point2<T>

The type of intersection.

fn intersects(&self, thing: &Point2<T>) -> bool

True if thing intersects with self.

fn intersection(&self, thing: &Point2<T>) -> Option<Self::Intersection>

If thing intersects with self, return the intersection. Otherwise, returns None.

impl<T: Unit> Intersection for Rect<T>

type Intersection = Rect<T>

The type of intersection.

fn intersects(&self, thing: &Rect<T>) -> bool

True if thing intersects with self.

fn intersection(&self, thing: &Rect<T>) -> Option<Self::Intersection>

If thing intersects with self, return the intersection. Otherwise, returns None.

impl<T: Unit> PartialEq<(Point2<T>, Size2<T>)> for Rect<T>

fn eq(&self, (origin, size): &(Point2<T>, Size2<T>)) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Unit> PartialEq for Rect<T>

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> RelativeEq<(Point2<T>, Size2<T>)> for Rect<T>

where T: Unit, T::Scalar: RelativeEq, <T::Scalar as AbsDiffEq>::Epsilon: Copy,

fn default_max_relative() -> Self::Epsilon

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

fn relative_eq( &self, other: &(Point2<T>, Size2<T>), 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: &(Point2<T>, Size2<T>), epsilon: Self::Epsilon, max_relative: Self::Epsilon ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: Unit> RelativeEq for Rect<T>

where T::Scalar: RelativeEq,

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> UlpsEq<(Point2<T>, Size2<T>)> for Rect<T>

where T::Scalar: UlpsEq, <T::Scalar as AbsDiffEq>::Epsilon: Copy,

fn default_max_ulps() -> u32

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

fn ulps_eq( &self, other: &(Point2<T>, Size2<T>), 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: &(Point2<T>, Size2<T>), epsilon: Self::Epsilon, max_ulps: u32 ) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T: Unit> UlpsEq for Rect<T>

where T::Scalar: UlpsEq,

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> Union for Rect<T>

where T: Unit,

type Union = Rect<T>

The type of the union.

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

Compute the union of two things.

impl<T: Unit> Zeroable for Rect<T>

SAFETY: All members are Pod, and we are #[repr(C)]

fn zeroed() -> Self

Calls zeroed.

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

impl<T> Eq for Rect<T>

where T: Unit, T::Scalar: Eq,

impl<T: Unit> Pod for Rect<T>

SAFETY: All members are Pod, and we are #[repr(C)]