Struct shape_core::Rectangle

pub struct Rectangle<T> {
    pub x: T,
    pub y: T,
    pub w: T,
    pub h: 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

x: T

origin x point of the rectangle

y: T

origin y point of the rectangle

w: T

width of the rectangle_2d

h: T

height of the rectangle_2d

Implementations

impl<T> Rectangle<T>

Constructors for rectangle_2d

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

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_origin<P>(origin: P, width: T, height: T) -> Selfwhere T: Clone + One + Add<Output = T> + Sub<Output = T> + Div<Output = T>, P: Into<Point<T>>,

Create a rectangle_2d from origin 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_origin((0.0, 0.0), 1.0, 1.0);

pub fn from_center<P>(center: P, width: T, height: T) -> Selfwhere 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_diagonal<P1, P2>(p1: P1, p2: P2) -> Rectangle<T>where P1: Into<Point<T>>, P2: Into<Point<T>>, T: Clone + Sub<Output = 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_diagonal((0.0, 0.0), (1.0, 1.0));

impl<T> Rectangle<T>

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

Get the origin point of the rectangle_2d

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_2d

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

Move reference to the inner value

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 for Rectangle<T>where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Rectangle<T>where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Rectangle<T>

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

Formats the value using the given formatter.

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

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

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> 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> Serialize for Rectangle<T>where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Shape2D for Rectangle<T>where T: Signed + Clone,

type Value = T

The value type of the shape.

fn is_valid(&self) -> bool

Returns true if the shape is valid and in normal form.

fn normalize(&mut self) -> bool

Returns true if the shape successfully normalized.

fn boundary(&self) -> Rectangle<Self::Value>

Returns the boundary of the shape.

fn vertices(&self, _: usize) -> impl Iterator<Item = Point<Self::Value>> + '_

Returns the owned vertices of the shape.

fn edges(&self, _: usize) -> impl Iterator<Item = Line<Self::Value>> + '_

Returns the owned edges of the shape.

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>