Struct Rectangle

pub struct Rectangle<T> {
    pub min: Point<T>,
    pub max: Point<T>,
}

A non-rotated rectangle, used to represent AABB collision boxes.

Notice

The constructor will not check the legality of the parameters, it is possible that two points coincide, or the side length is negative

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);

Fields

min: Point<T>

origin x points of the rectangle

max: Point<T>

origin y points of the rectangle

Implementations

impl<T> Rectangle<T>

Constructors for rectangle_2d

pub fn empty() -> Rectangle<T>

where T: Zero,

Create a rectangle_2d from 4 properties

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Rectangle::empty();

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

where T: Clone + Add<Output = T>,

Create a rectangle_2d from 4 properties

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);

pub fn from_anchor<P>(origin: P, width: T, height: T) -> Rectangle<T>

where T: Clone + Add<Output = T>, P: Into<Point<T>>,

Create a [Rectangle] from anchor (top left point) and 2 properties

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Rectangle::from_anchor((0.0, 0.0), 1.0, 1.0);

pub fn from_center<P>(center: P, width: T, height: T) -> Rectangle<T>

where T: Clone + One + Add<Output = T> + Sub<Output = T> + Div<Output = T>, P: Into<Point<T>>,

Create a rectangle_2d from center and 2 properties

Notice

The constructor will not check the legality of the parameters, call [is_valid] to ensure that the rectangle_2d is legal.

Examples

let rect = Rectangle::from_center((0.0, 0.0), 1.0, 1.0);

pub fn from_origin(width: T, height: T) -> Rectangle<T>

where T: Clone + Zero<Output = T> + One + Add + Sub<Output = T> + Div<Output = T>,

pub fn from_min_max<P1, P2>(min: P1, max: P2) -> Rectangle<T>

where P1: Into<Point<T>>, P2: Into<Point<T>>,

Create a rectangle_2d from two diagonal points.

Notice

The constructor will not check the legality of the parameters, it is possible that two points coincide, or the side length is negative

Examples

let rect = Rectangle::from_min_max((0.0, 0.0), (1.0, 1.0));

impl<T> Rectangle<T>

pub fn width(&self) -> T

where T: Clone + Sub<Output = T>,

Get the width of the rectangle

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);
assert_eq!(rect.width(), 1.0);

pub fn height(&self) -> T

where T: Clone + Sub<Output = T>,

Get the height of the rectangle

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);
assert_eq!(rect.height(), 1.0);

pub fn origin(&self) -> Point<T>

where T: Clone,

Get the origin of the rectangle

Examples

let rect = Rectangle::from_center((0.0, 0.0), 1.0,1.0);
assert_eq!(rect.origin(), -Point::new(0.5, 0.5));

pub fn center(&self) -> Point<T>

where T: Clone + One + Add<Output = T> + Sub<Output = T> + Div<Output = T>,

Get the center point of the rectangle

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);
assert_eq!(rect.center(), Point::new(0.5, 0.5));

pub fn ref_inner(&self) -> Rectangle<&T>

Move reference to the inner value

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

where T: Clone + PartialOrd,

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

where T: Clone + PartialOrd,

Check if two rectangle had overlapped

pub fn area(&self) -> T

where T: Clone + Mul<Output = T> + Sub<Output = T>,

Get the area of the rectangle

Examples

let rect = Rectangle::new(0.0, 0.0, 2.0, 2.0);
assert_eq!(rect.area(), 4.0);

Trait Implementations

impl<T> BitAndAssign for Rectangle<T>

where T: PartialOrd,

fn bitand_assign(&mut self, rhs: Rectangle<T>)

Returns the intersection of two rectangles, possibly with negative area, meaning the empty set

impl<T> BitOrAssign for Rectangle<T>

where T: PartialOrd,

fn bitor_assign(&mut self, rhs: Rectangle<T>)

Returns a larger rectangle that encompasses these two rectangles

impl<T> Clone for Rectangle<T>

where T: Clone,

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

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Display for Rectangle<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> Hash for Rectangle<T>

where T: Hash,

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for Rectangle<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

impl<T> Shape2D for Rectangle<T>

where T: Signed + Clone + PartialOrd,

fn is_valid(&self) -> bool

A valid rectangle means it has a positive area.

Examples

let rect = Rectangle::new(0.0, 0.0, 1.0, 1.0);
assert!(rect.is_valid());

fn boundary(&self) -> Rectangle<<Rectangle<T> as Shape2D>::Value>

SAFETY

It may return a zero area rectangle if shape is not valid.

It never returns a rectangle with negative area.

Examples

let rect = Rectangle::new(0.0, 0.0, -1.0, -1.0);
assert_eq!(rect.boundary(), Rectangle::new(0.0,0.0, 1.0,1.0));

fn vertices<'a>( &'a self, _: usize, ) -> <Rectangle<T> as Shape2D>::VertexIterator<'a>

Returns four vertices counterclockwise in the ↑Y coordinate system

fn edges<'a>(&'a self, _: usize) -> <Rectangle<T> as Shape2D>::LineIterator<'a>

Returns four edges counterclockwise in the ↑Y coordinate system

type Value = T

The value type of the shape.

type VertexIterator<'a> = IntoIter<Point<T>> where T: 'a

The value type of the shape.

type LineIterator<'a> = IntoIter<Line<T>> where T: 'a

The value type of the shape.

fn normalize(&mut self) -> bool

Returns true if the shape successfully normalized.

impl<T> Copy for Rectangle<T>

where T: Copy,

impl<T> Eq for Rectangle<T>

where T: Eq,

impl<T> StructuralPartialEq for Rectangle<T>