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
sourceimpl<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>) -> bool where
T: Add<Output = T> + PartialOrd,
pub fn intersects(&self, other: &Rectangle<T>) -> bool where
T: Add<Output = T> + PartialOrd,
Returns true
if the other
rectangle intersects with self
.
sourcepub fn contains(&self, other: &Rectangle<T>) -> bool where
T: Add<Output = T> + PartialOrd,
pub fn contains(&self, other: &Rectangle<T>) -> bool where
T: Add<Output = T> + PartialOrd,
Returns true
if the other
rectangle is fully contained within self
.
sourcepub fn contains_point(&self, point: Vec2<T>) -> bool where
T: Add<Output = T> + PartialOrd,
pub fn contains_point(&self, point: Vec2<T>) -> bool where
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> where
T: Add<Output = T> + Sub<Output = T> + PartialOrd,
pub fn combine(&self, other: &Rectangle<T>) -> Rectangle<T> where
T: Add<Output = T> + Sub<Output = T> + PartialOrd,
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) -> T where
T: Add<Output = T>,
pub fn right(&self) -> T where
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) -> T where
T: Add<Output = T>,
pub fn bottom(&self) -> T where
T: Add<Output = T>,
Returns the Y co-ordinate of the bottom of the rectangle.
sourcepub fn center(&self) -> Vec2<T> where
T: One + Add<Output = T> + Div<Output = T>,
pub fn center(&self) -> Vec2<T> where
T: One + Add<Output = T> + Div<Output = T>,
Returns the co-ordinates of the center point 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> StructuralEq for Rectangle<T>
impl<T> StructuralPartialEq for Rectangle<T>
Auto Trait Implementations
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
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
impl<T> Pointable for T
impl<T> Pointable for T
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