Struct axgeom::Rect

#[must_use]
pub struct Rect<T> {
    pub x: Range<T>,
    pub y: Range<T>,
}

An axis aligned rectangle. Stored as two Ranges. It is a semi-closed rectangle. A point is considered inside the rectangle if it is in [start,end) for both x and y.

Fields

x: Range<T>

y: Range<T>

Methods

impl<S: Copy> Rect<S>

pub fn inner_into<A: From<S>>(&self) -> Rect<A>

pub fn inner_try_into<A: TryFrom<S>>(&self) -> Result<Rect<A>, A::Error>

impl<T: Copy + Sub<Output = T> + Add<Output = T>> Rect<T>

pub fn from_point(point: Vec2<T>, radius: Vec2<T>) -> Rect<T>

Create a rectangle from a point and radius.

impl<T> Rect<T>

pub fn get_range(&self, axis: impl Axis) -> &Range<T>

Get the range of one axis.

pub fn get_range_mut(&mut self, axis: impl Axis) -> &mut Range<T>

Get the mutable range of one axis.

impl<T> Rect<T>

pub fn new(a: T, b: T, c: T, d: T) -> Rect<T>

(a,b) is the x component range. (c,d) is the y component range.

impl<T: Copy> Rect<T>

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

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

Returns each corner in this order: topleft topright bottomright bottomleft

pub fn inner_as<B: PrimitiveFrom<T>>(&self) -> Rect<B>

pub fn get(&self) -> ((T, T), (T, T))

(a,b) is the x component range. (c,d) is the y component range.

impl<T: PartialOrd + Copy> Rect<T>

pub fn contains_point(&self, a: Vec2<T>) -> bool

Returns true if the point is contained in the the ranges of both axis.

impl<T: Copy + Sub<Output = T> + Add<Output = T>> Rect<T>

pub fn grow(&mut self, radius: T) -> &mut Self

Grow a rectangle of a radius.

impl<T: Copy + PartialOrd + Sub<Output = T> + Mul<Output = T> + Add<Output = T>> Rect<T>

pub fn distance_squared_to_point(&self, point: Vec2<T>) -> Option<T>

If the point is outisde the rectangle, returns the squared distance from a point to a rectangle. If the point is inside the rectangle, it will return None.

impl<T: Num + Copy> Rect<T>

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

impl<T: PartialOrd + Copy> Rect<T>

pub fn subdivide<A: Axis>(&self, axis: A, divider: T) -> (Rect<T>, Rect<T>)

Subdivides the rectangle. No floating point calculations are done. Important to note that a point that was in the original rectangle, could actually be inside both subdivded rectangles. This is because the ranges are inclusive on both sides [start,end].

pub fn is_valid(&self) -> bool

Returns true if the rectangle's ranges are not degenerate.

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

Returns true if the specified rect is inside of this rect.

pub fn grow_to_fit(&mut self, rect: &Rect<T>) -> &mut Self

Grow the rectangle to fit the specified rectangle by replacing values with the specified rectangle. No floating point computations.

pub fn intersects_rect(&self, other: &Rect<T>) -> bool

impl<T: Ord + Copy> Rect<T>

pub fn get_intersect_rect(&self, other: &Rect<T>) -> Option<Rect<T>>

Get an intersecting rectangle. No floating point calculations as the new rectangle is made up of values from this rectangle and the specified rectangle.

Trait Implementations

impl<B> AsMut<[B; 4]> for Rect<B>

fn as_mut(&mut self) -> &mut [B; 4]

Performs the conversion.

impl<B> AsRef<[B; 4]> for Rect<B>

fn as_ref(&self) -> &[B; 4]

Performs the conversion.

impl<N: Float> AsRef<Rect<N>> for Rect<NotNan<N>>

fn as_ref(&self) -> &Rect<N>

Performs the conversion.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

impl<'a, B> From<&'a [B; 4]> for &'a Rect<B>

fn from(a: &'a [B; 4]) -> Self

Performs the conversion.

impl<'a, B> From<&'a mut [B; 4]> for &'a mut Rect<B>

fn from(a: &'a mut [B; 4]) -> Self

Performs the conversion.

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

fn from(a: [B; 4]) -> Self

Performs the conversion.

impl<B> Into<[B; 4]> for Rect<B>

fn into(self) -> [B; 4]

Performs the conversion.

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

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

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

fn ne(&self, other: &Rect<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for Rect<T>

impl<T> StructuralPartialEq for Rect<T>