pub struct Rectangle<T = f32> {
pub x: T,
pub y: T,
pub width: T,
pub height: T,
}
Expand description
Fields§
§x: T
The X co-ordinate of the rectangle.
y: T
The Y co-ordinate of the rectangle.
width: T
The width of the rectangle.
height: T
The height of the rectangle.
Implementations§
Source§impl<T> Rectangle<T>where
T: Copy,
impl<T> Rectangle<T>where
T: Copy,
Sourcepub fn row(
x: T,
y: T,
width: T,
height: T,
) -> impl Iterator<Item = Rectangle<T>>where
T: AddAssign,
pub fn row(
x: T,
y: T,
width: T,
height: T,
) -> impl Iterator<Item = Rectangle<T>>where
T: AddAssign,
Returns an infinite iterator of horizontally adjecent rectangles, starting at the specified point and increasing along the X axis.
This can be useful when slicing spritesheets.
§Examples
let rects: Vec<Rectangle> = Rectangle::row(0.0, 0.0, 16.0, 16.0).take(3).collect();
assert_eq!(Rectangle::new(0.0, 0.0, 16.0, 16.0), rects[0]);
assert_eq!(Rectangle::new(16.0, 0.0, 16.0, 16.0), rects[1]);
assert_eq!(Rectangle::new(32.0, 0.0, 16.0, 16.0), rects[2]);
Sourcepub fn column(
x: T,
y: T,
width: T,
height: T,
) -> impl Iterator<Item = Rectangle<T>>where
T: AddAssign,
pub fn column(
x: T,
y: T,
width: T,
height: T,
) -> impl Iterator<Item = Rectangle<T>>where
T: AddAssign,
Returns an infinite iterator of vertically adjecent rectangles, starting at the specified point and increasing along the Y axis.
This can be useful when slicing spritesheets.
§Examples
let rects: Vec<Rectangle> = Rectangle::column(0.0, 0.0, 16.0, 16.0).take(3).collect();
assert_eq!(Rectangle::new(0.0, 0.0, 16.0, 16.0), rects[0]);
assert_eq!(Rectangle::new(0.0, 16.0, 16.0, 16.0), rects[1]);
assert_eq!(Rectangle::new(0.0, 32.0, 16.0, 16.0), rects[2]);
Sourcepub fn intersects(&self, other: &Rectangle<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
pub fn intersects(&self, other: &Rectangle<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
Returns true
if the other
rectangle intersects with self
.
Sourcepub fn contains(&self, other: &Rectangle<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
pub fn contains(&self, other: &Rectangle<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
Returns true
if the other
rectangle is fully contained within self
.
Sourcepub fn contains_point(&self, point: Vec2<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
pub fn contains_point(&self, point: Vec2<T>) -> boolwhere
T: Add<Output = T> + PartialOrd,
Returns true
if the provided point is within the bounds of self
.
Sourcepub fn combine(&self, other: &Rectangle<T>) -> Rectangle<T>
pub fn combine(&self, other: &Rectangle<T>) -> Rectangle<T>
Returns a rectangle that contains both self
and other
.
Sourcepub fn left(&self) -> T
pub fn left(&self) -> T
Returns the X co-ordinate of the left side of the rectangle.
You can also obtain this via the x
field - this method is provided for
symmetry with the right
method.
Sourcepub fn right(&self) -> Twhere
T: Add<Output = T>,
pub fn right(&self) -> Twhere
T: Add<Output = T>,
Returns the X co-ordinate of the right side of the rectangle.
Sourcepub fn top(&self) -> T
pub fn top(&self) -> T
Returns the Y co-ordinate of the top of the rectangle.
You can also obtain this via the y
field - this method is provided for
symmetry with the bottom
method.
Sourcepub fn bottom(&self) -> Twhere
T: Add<Output = T>,
pub fn bottom(&self) -> Twhere
T: Add<Output = T>,
Returns the Y co-ordinate of the bottom of the rectangle.
Sourcepub fn top_left(&self) -> Vec2<T>
pub fn top_left(&self) -> Vec2<T>
Returns the co-ordinates of the top-left point of the rectangle.
Sourcepub fn top_right(&self) -> Vec2<T>where
T: Add<Output = T>,
pub fn top_right(&self) -> Vec2<T>where
T: Add<Output = T>,
Returns the co-ordinates of the top-right point of the rectangle.
Sourcepub fn bottom_left(&self) -> Vec2<T>where
T: Add<Output = T>,
pub fn bottom_left(&self) -> Vec2<T>where
T: Add<Output = T>,
Returns the co-ordinates of the bottom-left point of the rectangle.
Sourcepub fn bottom_right(&self) -> Vec2<T>where
T: Add<Output = T>,
pub fn bottom_right(&self) -> Vec2<T>where
T: Add<Output = T>,
Returns the co-ordinates of the bottom-right point of the rectangle.
Trait Implementations§
impl<T: Copy> Copy for Rectangle<T>
impl<T: Eq> Eq for Rectangle<T>
impl<T> StructuralPartialEq for Rectangle<T>
Auto Trait Implementations§
impl<T> Freeze for Rectangle<T>where
T: Freeze,
impl<T> RefUnwindSafe for Rectangle<T>where
T: RefUnwindSafe,
impl<T> Send for Rectangle<T>where
T: Send,
impl<T> Sync for Rectangle<T>where
T: Sync,
impl<T> Unpin for Rectangle<T>where
T: Unpin,
impl<T> UnwindSafe for Rectangle<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more