pub struct Rect<P, E> {
pub x: P,
pub y: P,
pub w: E,
pub h: E,
}
Expand description
2D rectangle, represented by a bottom-left position, and 2D extents.
Most operations on a Rect
are better done by converting it to
Aabr
form. In fact, most existing code in the wild implicitly does this
and so does this crate.
Aabr
structs are often more convenient, faster and probably less confusing.
The Rect
type is provided because it exists for a lot of APIs (including
some system APIs, OpenGL, and others).
Please note that in most APIs in the wild (but NOT in vek
), the Y axis
is treated as pointing downwards because it’s the one of window space.
Keeping the Y axis upwards is a lot more convenient implementation-wise, and still matches the convention used in 3D spaces.
Fields
x: P
X position of the bottom-left corner.
y: P
Y position of the bottom-left corner.
w: E
Width.
h: E
Height, with Y axis going upwards.
Implementations
sourceimpl<P, E> Rect<P, E>
impl<P, E> Rect<P, E>
sourcepub fn new(x: P, y: P, w: E, h: E) -> Self
pub fn new(x: P, y: P, w: E, h: E) -> Self
Creates a new rectangle from position elements and extent elements.
sourcepub fn position_extent(self) -> (Vec2<P>, Extent2<E>)
pub fn position_extent(self) -> (Vec2<P>, Extent2<E>)
Gets this rectangle’s position and extent (size).
sourcepub fn map<DP, DE, PF, EF>(self, pf: PF, ef: EF) -> Rect<DP, DE> where
PF: FnMut(P) -> DP,
EF: FnMut(E) -> DE,
pub fn map<DP, DE, PF, EF>(self, pf: PF, ef: EF) -> Rect<DP, DE> where
PF: FnMut(P) -> DP,
EF: FnMut(E) -> DE,
Returns this rectangle, converted with the given closures (one for position elements, the other for extent elements).
sourcepub fn as_<DP, DE>(self) -> Rect<DP, DE> where
P: AsPrimitive<DP>,
DP: 'static + Copy,
E: AsPrimitive<DE>,
DE: 'static + Copy,
pub fn as_<DP, DE>(self) -> Rect<DP, DE> where
P: AsPrimitive<DP>,
DP: 'static + Copy,
E: AsPrimitive<DE>,
DE: 'static + Copy,
Converts this rectangle to a rectangle of another type, using the as
conversion.
sourceimpl<T> Rect<T, T> where
T: Copy + Add<T, Output = T>,
impl<T> Rect<T, T> where
T: Copy + Add<T, Output = T>,
sourcepub fn into_aabr(self) -> Aabr<T>
pub fn into_aabr(self) -> Aabr<T>
Converts this into the matching axis-aligned bounding shape representation.
sourcepub fn contains_point(self, p: Vec2<T>) -> bool where
T: PartialOrd,
pub fn contains_point(self, p: Vec2<T>) -> bool where
T: PartialOrd,
Does this rectangle contain the given point ?
sourcepub fn contains_rect(self, other: Self) -> bool where
T: PartialOrd,
pub fn contains_rect(self, other: Self) -> bool where
T: PartialOrd,
Does this rectangle fully contain the given one ?
sourcepub fn collides_with_rect(self, other: Self) -> bool where
T: PartialOrd,
pub fn collides_with_rect(self, other: Self) -> bool where
T: PartialOrd,
Does this rectangle collide with another ?
sourceimpl<T> Rect<T, T> where
T: Copy + PartialOrd + Sub<T, Output = T> + Add<T, Output = T>,
impl<T> Rect<T, T> where
T: Copy + PartialOrd + Sub<T, Output = T> + Add<T, Output = T>,
sourcepub fn expanded_to_contain_point(self, p: Vec2<T>) -> Self where
T: PartialOrd,
pub fn expanded_to_contain_point(self, p: Vec2<T>) -> Self where
T: PartialOrd,
Returns this shape so that it contains the given point.
sourcepub fn expand_to_contain_point(&mut self, p: Vec2<T>) where
T: PartialOrd,
pub fn expand_to_contain_point(&mut self, p: Vec2<T>) where
T: PartialOrd,
Expands this shape so that it contains the given point.
sourcepub fn union(self, other: Self) -> Self
pub fn union(self, other: Self) -> Self
Gets the smallest rectangle that contains both this one and another.
sourcepub fn intersection(self, other: Self) -> Self
pub fn intersection(self, other: Self) -> Self
Gets the largest rectangle contained by both this one and another.
sourcepub fn expand_to_contain(&mut self, other: Self)
pub fn expand_to_contain(&mut self, other: Self)
Sets this rectangle to the union of itself with another.
sourcepub fn intersect(&mut self, other: Self)
pub fn intersect(&mut self, other: Self)
Sets this rectangle to the intersection of itself with another.
sourcepub fn collision_vector_with_rect(self, other: Self) -> Vec2<T> where
T: One + Div<T, Output = T>,
pub fn collision_vector_with_rect(self, other: Self) -> Vec2<T> where
T: One + Div<T, Output = T>,
Gets a vector that tells how much self
penetrates other
.
sourcepub fn split_at_x(self, sp: T) -> [Self; 2]
pub fn split_at_x(self, sp: T) -> [Self; 2]
Splits this shape in two, by a straight plane along the
x
axis.
The returned tuple is (low, high)
.
Panics
sp
is assumed to be a position along the
x
axis that is within this shape’s bounds.
sourcepub fn split_at_y(self, sp: T) -> [Self; 2]
pub fn split_at_y(self, sp: T) -> [Self; 2]
Splits this shape in two, by a straight plane along the
y
axis.
The returned tuple is (low, high)
.
Panics
sp
is assumed to be a position along the
y
axis that is within this shape’s bounds.
Trait Implementations
sourceimpl<'de, P, E> Deserialize<'de> for Rect<P, E> where
P: Deserialize<'de>,
E: Deserialize<'de>,
impl<'de, P, E> Deserialize<'de> for Rect<P, E> where
P: Deserialize<'de>,
E: Deserialize<'de>,
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<P: Copy, E: Copy> Copy for Rect<P, E>
impl<P: Eq, E: Eq> Eq for Rect<P, E>
impl<P, E> StructuralEq for Rect<P, E>
impl<P, E> StructuralPartialEq for Rect<P, E>
Auto Trait Implementations
impl<P, E> RefUnwindSafe for Rect<P, E> where
E: RefUnwindSafe,
P: RefUnwindSafe,
impl<P, E> Send for Rect<P, E> where
E: Send,
P: Send,
impl<P, E> Sync for Rect<P, E> where
E: Sync,
P: Sync,
impl<P, E> Unpin for Rect<P, E> where
E: Unpin,
P: Unpin,
impl<P, E> UnwindSafe for Rect<P, E> where
E: UnwindSafe,
P: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more