Struct broccoli::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>

Implementations

impl<S> Rect<S> where
    S: Copy, 

pub fn inner_into<A>(&self) -> Rect<A> where
    S: Into<A>, 

#[must_use]pub fn inner_try_into<A>(&self) -> Result<Rect<A>, <S as TryInto<A>>::Error> where
    S: TryInto<A>, 

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

#[must_use]pub fn from_point(point: Vec2<T>, radius: Vec2<T>) -> Rect<T>

Create a rectangle from a point and radius.

impl<T> Rect<T>

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

Get the range of one axis.

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

Get the mutable range of one axis.

impl<T> Rect<T>

#[must_use]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> Rect<T> where
    T: Copy, 

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>(&self) -> Rect<B> where
    B: 'static + Copy,
    T: AsPrimitive<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> Rect<T> where
    T: PartialOrd<T> + Copy, 

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> Rect<T> where
    T: Add<T, Output = T> + Sub<T, Output = T> + Copy, 

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

Grow a rectangle of a radius.

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

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> Rect<T> where
    T: Copy + Num, 

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

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

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

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_point(&mut self, point: Vec2<T>) -> &mut Rect<T>

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

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> Rect<T> where
    T: Ord + Copy, 

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<N: Num> Aabb for Rect<N>

type Num = N

fn get(&self) -> &Rect<Self::Num>

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<N> AsRef<Rect<N>> for Rect<NotNan<N>> where
    N: FloatCore, 

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

Performs the conversion.

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

pub 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 for Rect<T> where
    T: Copy, 

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

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

Formats the value using the given formatter.

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

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

pub fn from(a: &'a [B; 4]) -> &'a Rect<B>

Performs the conversion.

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

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

Performs the conversion.

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

pub fn from(a: [B; 4]) -> Rect<B>

Performs the conversion.

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

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

Performs the conversion.

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

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

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

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

This method tests for !=.

impl<T> StructuralEq for Rect<T>

impl<T> StructuralPartialEq for Rect<T>