Struct speedy2d::shape::Rectangle

#[repr(C)]
pub struct Rectangle<T = f32> { /* private fields */ }

A struct representing an axis-aligned rectangle. Two points are stored: the top left vertex, and the bottom right vertex.

Implementations

impl<T> Rectangle<T>

pub const fn new(top_left: Vector2<T>, bottom_right: Vector2<T>) -> Self

Constructs a new Rectangle. The top left vertex must be above and to the left of the bottom right vertex.

pub fn from_tuples(top_left: (T, T), bottom_right: (T, T)) -> Self

Constructs a new Rectangle. The top left vertex must be above and to the left of the bottom right vertex.

pub const fn top_left(&self) -> &Vector2<T>

Returns a reference to the top left vertex.

pub const fn bottom_right(&self) -> &Vector2<T>

Returns a reference to the bottom right vertex.

impl<T: Copy> Rectangle<T>

pub fn top_right(&self) -> Vector2<T>

Returns a vector representing the top right vertex.

pub fn bottom_left(&self) -> Vector2<T>

Returns a vector representing the bottom left vertex.

impl<T: Sub<Output = T> + Copy> Rectangle<T>

pub fn width(&self) -> T

Returns the width of the rectangle.

pub fn height(&self) -> T

Returns the height of the rectangle.

pub fn size(&self) -> Vector2<T>

Returns a Vector2 containing the width and height of the rectangle.

impl<T: PartialOrd<T> + Copy> Rectangle<T>

pub fn contains(&self, point: Vector2<T>) -> bool

Returns true if the specified point is inside this rectangle. This is inclusive of the top and left coordinates, and exclusive of the bottom and right coordinates.

impl<T: PartialOrd + Copy> Rectangle<T>

pub fn intersect(&self, other: &Self) -> Option<Self>

Finds the intersection of two rectangles – in other words, the area that is common to both of them.

If there is no common area between the two rectangles, then this function will return None.

impl<T: PrimitiveZero> Rectangle<T>

pub const ZERO: Rectangle<T> = _

A constant representing a rectangle with position (0, 0) and zero area. Each component is set to zero.

impl<T: PartialEq> Rectangle<T>

pub fn is_zero_area(&self) -> bool

Returns true if the rectangle has zero area.

impl<T: PartialOrd> Rectangle<T>

pub fn is_positive_area(&self) -> bool

Returns true if the rectangle has an area greater than zero.

impl<T: Copy> Rectangle<T>where
    Vector2<T>: Add<Output = Vector2<T>>,

pub fn with_offset(&self, offset: impl Into<Vector2<T>>) -> Self

Returns a new rectangle, whose vertices are offset relative to the current rectangle by the specified amount. This is equivalent to adding the specified vector to each vertex.

impl<T: Copy> Rectangle<T>where
    Vector2<T>: Sub<Output = Vector2<T>>,

pub fn with_negative_offset(&self, offset: impl Into<Vector2<T>>) -> Self

Returns a new rectangle, whose vertices are negatively offset relative to the current rectangle by the specified amount. This is equivalent to subtracting the specified vector to each vertex.

impl<T: AsPrimitive<f32>> Rectangle<T>

pub fn into_f32(self) -> Rectangle<f32>

Returns a new rectangle where the coordinates have been cast to f32 values, using the as operator.

impl<T: AsPrimitive<f32> + Copy> Rectangle<T>

pub fn as_f32(&self) -> Rectangle<f32>

Returns a new rectangle where the coordinates have been cast to f32 values, using the as operator.

Trait Implementations

impl<T: Clone> Clone for Rectangle<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Copy> From<&Rect<T>> for Rectangle<T>

fn from(rect: &Rect<T>) -> Self

Converts to this type from the input type.

impl<T> From<Rect<T>> for Rectangle<T>

fn from(rect: Rect<T>) -> Self

Converts to this type from the input type.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

impl<T> StructuralEq for Rectangle<T>

impl<T> StructuralPartialEq for Rectangle<T>