Struct tetra::graphics::Rectangle

pub struct Rectangle<T = f32> {
    pub x: T,
    pub y: T,
    pub width: T,
    pub height: T,
}

A rectangle, represented by a top-left position, a width and a height.

Serde

Serialization and deserialization of this type (via Serde) can be enabled via the serde_support feature.

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

impl<T> Rectangle<T>

pub const fn new(x: T, y: T, width: T, height: T) -> Rectangle<T>

Creates a new Rectangle.

impl<T> Rectangle<T> where
    T: Copy, 

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]);

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]);

pub fn intersects(&self, other: &Rectangle<T>) -> bool where
    T: Add<Output = T> + PartialOrd, 

Returns true if the other rectangle intersects with self.

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.

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.

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.

pub fn right(&self) -> T where
    T: Add<Output = T>, 

Returns the X co-ordinate of the right side of the rectangle.

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.

pub fn bottom(&self) -> T where
    T: Add<Output = T>, 

Returns the Y co-ordinate of the bottom of the rectangle.

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.

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

Returns the co-ordinates of the top-left point of the rectangle.

pub fn top_right(&self) -> Vec2<T> where
    T: Add<Output = T>, 

Returns the co-ordinates of the top-right point of the rectangle.

pub fn bottom_left(&self) -> Vec2<T> where
    T: Add<Output = T>, 

Returns the co-ordinates of the bottom-left point of the rectangle.

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: Clone> Clone for Rectangle<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Rectangle<T>

impl<T: Debug> Debug for Rectangle<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Rectangle<T>

fn default() -> Rectangle<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Rectangle<T>

impl<T: Hash> Hash for Rectangle<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Rectangle<T>> for Rectangle<T>

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

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

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

This method tests for !=.

impl<T> StructuralEq for Rectangle<T>

impl<T> StructuralPartialEq for Rectangle<T>