Struct Rect 

#[repr(C)]
pub struct Rect<T> {
    pub x: T,
    pub y: T,
    pub w: T,
    pub h: T,
}

A 2D axis-aligned rectangle.

Most of the methods for this struct assume that the rectangle has a positive width and height, so rectangles where T is signed may yield incorrect values for negative-sized instances.

Fields

x: T

y: T

w: T

h: T

Implementations

impl<T: Copy + AbsDiffEq<Epsilon = T>> Rect<T>

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

Returns true if the two values are approximately equal according to the absolute difference between their components.

impl<T: Copy + RelativeEq<Epsilon = T>> Rect<T>

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

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as relative-based comparisons.

impl<T: Copy + UlpsEq<Epsilon = T>> Rect<T>

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

Returns true if the two values are approximately equal according to the absolute difference between their components, as well as ULPs (Units in Last Place).

impl<T: Pod + NoUninit> Rect<T>

pub fn as_bytes(&self) -> &[u8]

This type re-interpreted as a slice of bytes.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

This type re-interpreted as a mutable slice of bytes.

impl<T> Rect<T>

pub const fn new(x: T, y: T, w: T, h: T) -> Self

Create a new rectangle.

pub fn map<U, F: FnMut(T) -> U>(self, f: F) -> Rect<U>

Map the rectangle from one type to another.

impl<T: Copy> Rect<T>

pub fn size(&self) -> Vec2<T>

The width and height of the rectangle.

pub fn left(&self) -> T

The left edge of the rectangle. Equivalent to x.

pub fn top(&self) -> T

The top edge of the rectangle. Equivalent to y.

pub fn top_left(&self) -> Vec2<T>

The top-left point of the rectangle.

impl<T: Num> Rect<T>

pub const ZERO: Self

A zero-sized rectangle.

pub const fn sized(size: Vec2<T>) -> Self

A rectangle at (0, 0) with the provided width and height.

pub const fn pos_size(pos: Vec2<T>, size: Vec2<T>) -> Self

A rectangle at pos with the size.

pub fn right(&self) -> T

Right edge of the rectangle. Equivalent to x + w.

pub fn bottom(&self) -> T

Bottom edge of the rectangle. Equivalent to y + h.

pub fn top_right(&self) -> Vec2<T>

Top-right point of the rectangle.

pub fn bottom_right(&self) -> Vec2<T>

Bottom-right point of the rectangle.

pub fn bottom_left(&self) -> Vec2<T>

Bottom-left point of the rectangle.

pub fn center_x(&self) -> T

Center x-position of the rectangle.

pub fn center_y(&self) -> T

Cente y-position of the rectangle.

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

Center point of the rectangle.

pub fn top_center(&self) -> Vec2<T>

Center point along the rectangle’s top edge.

pub fn bottom_center(&self) -> Vec2<T>

Center point along the rectangle’s bottom edge.

pub fn right_center(&self) -> Vec2<T>

Center point along the rectangle’s right edge.

pub fn left_center(&self) -> Vec2<T>

Center point along the rectangle’s left edge.

pub fn area(&self) -> T

Area of the rectangle.

pub fn perimeter(&self) -> T

Length of the rectangle’s perimeter.

pub fn contains(&self, p: Vec2<T>) -> bool

Returns true if this rectangle contains the point.

pub fn translate(&self, amount: &Vec2<T>) -> Self

Translate the rectangle.

pub fn top_edge(&self) -> Line<T>

Top edge segment of the rectangle.

pub fn right_edge(&self) -> Line<T>

Right edge segment of the rectangle.

pub fn bottom_edge(&self) -> Line<T>

Bottom edge segment of the rectangle.

pub fn left_edge(&self) -> Line<T>

Left edge segment of the rectangle.

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

The rectangle’s 4 corner points.

pub fn edges(&self) -> [Line<T>; 4]

The rectangle’s 4 edges.

pub fn inflate(self, amount: impl Into<Vec2<T>>) -> Self

Inflate the rectangle by the amount.

pub fn min_x(&self) -> T

Absolute left bounds of the rectangle.

pub fn min_y(&self) -> T

Absolute top bounds of the rectangle.

pub fn max_x(&self) -> T

Absolute right bounds of the rectangle.

pub fn max_y(&self) -> T

Absolute bottom bounds of the rectangle.

pub fn min_pos(&self) -> Vec2<T>

Absolute top-left point of the rectangle.

pub fn max_pos(&self) -> Vec2<T>

Absolute bottom-right point of the rectangle.

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

If this rectangle contains the other.

pub fn overlaps(&self, r: &Self) -> bool

If this rectangle overlaps the other.

pub fn overlap(&self, r: &Self) -> Option<Self>

If this rectangle overlaps the other, returns a rectangle representing the overlapping region.

pub fn conflate(&self, r: &Self) -> Self

Return a rectangle that minimally encapsulates this rectangle and the other. This is useful if you have a lot of rectangles (or bounds) and want to find the minimal sum boundary that contains them all.

pub fn clamp_inside(&self, outer: &Self) -> Self

Return a rectangle that is this rectangle clamped inside of the provided outer rectangle. If this rectangle is larger than the outer by either dimension, it will be shrunk to fit.

impl<T: Signed> Rect<T>

pub fn is_positive(&self) -> bool

If the rectangle has a non-negative size.

pub fn non_neg(self) -> Self

If the rectangle has a negative width or height, invert it on those axes and return a corrected version with non-negative dimensions

impl<T: Float> Rect<T>

pub fn transform_by(&self, f: impl FnMut(Vec2<T>) -> Vec2<T>) -> Quad<T>

Transform the rectangle, producing a quad.

pub fn transform_by_retain(&self, f: impl FnMut(Vec2<T>) -> Vec2<T>) -> Rect<T>

Transform the rectangle, but retain the type.

impl<T: Float> Rect<T>

pub fn fitted(&self, size: Vec2<T>, fractional: bool) -> (Self, T)

pub fn map_pos(&self, pos: Vec2<T>, target: &Rect<T>) -> Vec2<T>

Trait Implementations

impl<T> AbsDiffEq for Rect<T>

where T: AbsDiffEq, T::Epsilon: Copy,

type Epsilon = <T 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: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<&Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the + operator.

fn add(self, rhs: &Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<T, Output = T>> Add<Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Add<T, Output = T>> Add<Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T: Copy + AddAssign<T>> AddAssign<&Vec2<T>> for Rect<T>

fn add_assign(&mut self, rhs: &Vec2<T>)

Performs the += operation.

impl<T: AddAssign<T>> AddAssign<Vec2<T>> for Rect<T>

fn add_assign(&mut self, rhs: Vec2<T>)

Performs the += operation.

impl<T: Clone> Clone for Rect<T>

fn clone(&self) -> Rect<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Rect<T>

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Rect<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Rect<T>

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

Formats the value using the given formatter.

impl<T: Num> Div<T> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: Num> Div<T> for Rect<T>

type Output = Rect<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: Num> Div<Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the / operator.

fn div(self, rhs: Vec2<T>) -> Self::Output

Performs the / operation.

impl<T: Num> Div<Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the / operator.

fn div(self, rhs: Vec2<T>) -> Self::Output

Performs the / operation.

impl<T: Num> DivAssign<T> for Rect<T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> From<[T; 4]> for Rect<T>

fn from([x, y, w, h]: [T; 4]) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T, T)> for Rect<T>

fn from((x, y, w, h): (T, T, T, T)) -> Self

Converts to this type from the input type.

impl<T> From<Rect<T>> for [T; 4]

fn from(_: Rect<T>) -> [T; 4]

Converts to this type from the input type.

impl<T> From<Rect<T>> for (T, T, T, T)

fn from(_: Rect<T>) -> (T, T, T, T)

Converts to this type from the input type.

impl<T> From<Rect<T>> for DynShape<T>

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

Converts to this type from the input type.

impl<T: Num> From<Rect<T>> for Polygon<T>

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

Converts to this type from the input type.

impl<T: Num> From<Rect<T>> for Quad<T>

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

Converts to this type from the input type.

impl<T: Hash> Hash for Rect<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

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: Float + Interp<Factor = T>> Interp for Rect<T>

type Factor = T

The factor by which this type is interpolated.

fn lerp(self, target: Self, t: Self::Factor) -> Self

Linear interpolation.

fn quad_bezier(self, control: Self, target: Self, t: Self::Factor) -> Self

Quadratic bezier interpolation.

fn cubic_bezier( self, control1: Self, control2: Self, target: Self, t: Self::Factor, ) -> Self

Cubic bezier interpolation.

fn hermite( self, tangent1: Self::Factor, target: Self, tangent2: Self::Factor, t: Self::Factor, ) -> Self

Cubic Hermite interpolation.

fn catmull_rom( self, control1: Self, control2: Self, target: Self, t: Self::Factor, ) -> Self

Catmull-Rom interpolation.

fn smooth_step(self, target: Self, t: Self::Factor) -> Self

Smooth-step interpolation.

impl<T: Num> Mul<T> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Num> Mul<T> for Rect<T>

type Output = Rect<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Num> Mul<Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<T>) -> Self::Output

Performs the * operation.

impl<T: Num> Mul<Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<T>) -> Self::Output

Performs the * operation.

impl<T: Num> MulAssign<T> for Rect<T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: Numeric<AsU8 = u8, AsU16 = u16, AsU32 = u32, AsU64 = u64, AsU128 = u128, AsUSize = usize, AsI8 = i8, AsI16 = i16, AsI32 = i32, AsI64 = i64, AsI128 = i128, AsISize = isize, AsF32 = f32, AsF64 = f64>> Numeric for Rect<T>

type AsU8 = Rect<u8>

type AsU16 = Rect<u16>

type AsU32 = Rect<u32>

type AsU64 = Rect<u64>

type AsU128 = Rect<u128>

type AsUSize = Rect<usize>

type AsI8 = Rect<i8>

type AsI16 = Rect<i16>

type AsI32 = Rect<i32>

type AsI64 = Rect<i64>

type AsI128 = Rect<i128>

type AsISize = Rect<isize>

type AsF32 = Rect<f32>

type AsF64 = Rect<f64>

fn to_u8(self) -> Rect<u8>

fn to_u16(self) -> Rect<u16>

fn to_u32(self) -> Rect<u32>

fn to_u64(self) -> Rect<u64>

fn to_u128(self) -> Rect<u128>

fn to_usize(self) -> Rect<usize>

fn to_i8(self) -> Rect<i8>

fn to_i16(self) -> Rect<i16>

fn to_i32(self) -> Rect<i32>

fn to_i64(self) -> Rect<i64>

fn to_i128(self) -> Rect<i128>

fn to_isize(self) -> Rect<isize>

fn to_f32(self) -> Rect<f32>

fn to_f64(self) -> Rect<f64>

impl<T: Ord> Ord for Rect<T>

fn cmp(&self, other: &Rect<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn eq(&self, other: &Rect<T>) -> 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: PartialOrd> PartialOrd for Rect<T>

fn partial_cmp(&self, other: &Rect<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Float> Polygonal<T> for Rect<T>

fn nearest_vertex(&self, source: Vec2<T>) -> Vec2<T>

Get the nearest point on this polygon to the source point.

fn all_edges<F: FnMut(Line<T>) -> bool>(&self, cond: F) -> bool

Iterate all polygonal edges of the shape, returning true if any of them satisfy the conditional function provided.

fn all_normals<F: FnMut(Vec2<T>) -> bool>(&self, cond: F) -> bool

Iterate all edge normals of the shape, returning true if any of them satisfy the conditional function provided.

fn visit_normals<F: FnMut(Vec2<T>)>(&self, plot: F)

Walk through every normal of the polygon.

fn visit_edges<F: FnMut(Line<T>)>(&self, plot: F)

Walk through every edge of the polygon.

impl<T> RelativeEq for Rect<T>

where T: RelativeEq, T::Epsilon: 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: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: Num> Rem<T> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T: Num> Rem<T> for Rect<T>

type Output = Rect<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T: Num> Rem<Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Vec2<T>) -> Self::Output

Performs the % operation.

impl<T: Num> Rem<Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Vec2<T>) -> Self::Output

Performs the % operation.

impl<T: Num> RemAssign<T> for Rect<T>

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T: Serialize> Serialize for Rect<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Float> Shape<T> for Rect<T>

fn centroid(&self) -> Vec2<T>

Centroid of the shape.

fn contains(&self, p: Vec2<T>) -> bool

If the point is contained within the shape.

fn bounds(&self) -> Rect<T>

Rectangular bounds of the shape.

fn project_onto_axis(&self, axis: Vec2<T>) -> Projection<T>

Project the shape onto the axis.

fn project_point(&self, p: Vec2<T>) -> Vec2<T>

Project a point onto the outside surface of the shape.

fn rayhit(&self, ray: &Ray<T>) -> bool

Check if a ray intersects this shape.

fn raycast(&self, ray: &Ray<T>) -> Option<RayHit<T>>

Raycast against the shape.

fn overlaps_rect(&self, rect: &Rect<T>) -> bool

If this shape overlaps the rectangle.

fn overlaps_circ(&self, circ: &Circle<T>) -> bool

If this shape overlaps the circle.

fn overlaps_poly<P: Polygonal<T>>(&self, poly: &P) -> bool

If this shape overlaps the polygon.

fn extract_from_circ(&self, circ: &Circle<T>) -> Option<Vec2<T>>

If this shape and the circle overlap, return a push-out vector that can be used to extract them from each other.

fn extract_from_poly<P: Polygonal<T>>(&self, poly: &P) -> Option<Vec2<T>>

If this shape and the polygon overlap, return a push-out vector that can be used to extract them from each other.

fn is_convex(&self) -> bool

If this shape is convex.

impl<T: Float + SmoothInterp<Factor = T>> SmoothInterp for Rect<T>

fn smooth_damp( &mut self, velocity: &mut Self, target: Self, smooth_time: Self::Factor, max_speed: Self::Factor, delta_time: Self::Factor, )

Accelerate towards a target with stateful velocity.

fn smooth_lerp(self, target: Self, t: Self::Factor, dt: Self::Factor) -> Self

Lerp towards a target with a framerate-invariant version.

impl<T: Copy + Sub<T, Output = T>> Sub<&Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<&Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>> Sub<Vec2<T>> for &Rect<T>

type Output = Rect<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Sub<T, Output = T>> Sub<Vec2<T>> for Rect<T>

type Output = Rect<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Vec2<T>) -> Self::Output

Performs the - operation.

impl<T: Copy + SubAssign<T>> SubAssign<&Vec2<T>> for Rect<T>

fn sub_assign(&mut self, rhs: &Vec2<T>)

Performs the -= operation.

impl<T: SubAssign<T>> SubAssign<Vec2<T>> for Rect<T>

fn sub_assign(&mut self, rhs: Vec2<T>)

Performs the -= operation.

impl<T> UlpsEq for Rect<T>

where T: UlpsEq, T::Epsilon: 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: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

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

fn zeroed() -> Self

Calls zeroed.

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

impl<T: Eq> Eq for Rect<T>

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

impl<T> StructuralPartialEq for Rect<T>