Struct iron_shapes::rect::Rect

pub struct Rect<T> where
    T: CoordinateType,  {
    pub lower_left: Point<T>,
    pub upper_right: Point<T>,
}

A rectangle which is oriented along the x an y axis and represented by its lower left and upper right corner.

Fields

lower_left: Point<T>

Lower left corner of the rectangle.

upper_right: Point<T>

Upper right corner of the rectangle.

Implementations

impl<T: CoordinateType> Rect<T>

pub fn new<C>(c1: C, c2: C) -> Self where
    C: Into<Point<T>>, 

Construct the bounding box of the two points. Order does not matter.

Examples

use iron_shapes::prelude::*;

// Create a rectangle based on two corner points.
let rect1 = Rect::new(Point::new(0, 0), Point::new(1, 2));
// Any type that implements `Into<Point<T>>` can be used for the corner points.
let rect2 = Rect::new((1, 2), (0, 0));
// Ordering of the corner points does not matter.
assert_eq!(rect1, rect2);
// Even though `(0, 0)` was passed as second argument it is recognized as lower left corner.
assert_eq!(rect2.lower_left(), Point::new(0, 0));

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

Get the lower left corner.

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

Get the upper left corner.

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

Get the upper right corner.

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

Get the lower right corner.

pub fn width(&self) -> T

Compute the width of the rectangle.

pub fn height(&self) -> T

Compute the height of the rectangle.

pub fn contains_point(&self, p: Point<T>) -> bool

Check if rectangle contains the point. Inclusive boundaries.

Example

use iron_shapes::prelude::*;
let rect = Rect::new((0, 0), (10, 20));
// Contains point somewhere in the center.
assert!(rect.contains_point(Point::new(5, 5)));
// Also contains point on the boundaries.
assert!(rect.contains_point(Point::new(0, 0)));
// Does not contain point outside of the rectangle.
assert!(!rect.contains_point(Point::new(10, 21)));

pub fn contains_point_exclusive(&self, p: Point<T>) -> bool

Check if rectangle contains the point. Exclusive boundaries.

Example

use iron_shapes::prelude::*;
let rect = Rect::new((0, 0), (10, 20));
// Contains point somewhere in the center.
assert!(rect.contains_point_exclusive(Point::new(5, 5)));
// Does not contain points on boundaries.
assert!(!rect.contains_point_exclusive(Point::new(0, 0)));
// Does not contain point outside of the rectangle.
assert!(!rect.contains_point_exclusive(Point::new(10, 21)));

pub fn contains_rectangle(&self, other: &Self) -> bool

Check if rectangle contains other rectangle. Inclusive boundaries.

Example

use iron_shapes::prelude::*;

let outer = Rect::new((0, 0), (2, 2));
let inner = Rect::new((0, 0), (1, 1));
assert!(outer.contains_rectangle(&inner));
assert!(!inner.contains_rectangle(&outer));

pub fn contains_rectangle_exclusive(&self, other: &Self) -> bool

Check if rectangle contains other rectangle. Exclusive boundaries.

Example

use iron_shapes::prelude::*;

let outer = Rect::new((0, 0), (3, 3));
let inner = Rect::new((1, 1), (2, 2));
assert!(outer.contains_rectangle_exclusive(&inner));
assert!(!inner.contains_rectangle_exclusive(&outer));

let not_inner = Rect::new((0, 0), (1, 1)); // This shares the boundary with `outer`.
assert!(!outer.contains_rectangle_exclusive(&not_inner));

pub fn touches(&self, other: &Self) -> bool

Test if the both rectangles touch each other, i.e. if they either share a boundary or are overlapping.

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

Compute the boolean intersection of two rectangles.

Example

use iron_shapes::prelude::*;

// Create two overlapping rectangles.
let a = Rect::new((0, 0), (2, 2));
let b = Rect::new((1, 1), (3, 3));

// Compute the intersection.
assert_eq!(a.intersection(&b), Some(Rect::new((1, 1), (2, 2))));

// Create a non-overlapping rectangle.
let c = Rect::new((100, 100), (200, 200));
// The intersection with a non-overlapping rectangle is `None`.
assert_eq!(a.intersection(&c), None);

pub fn add_point(&self, point: Point<T>) -> Self

Create the smallest Rect that contains the original Rect and the point.

Example

use iron_shapes::prelude::*;

let r1 = Rect::new((0,0), (1,2));

let r2 = r1.add_point(Point::new(10, 11));

assert_eq!(r2, Rect::new((0,0), (10,11)));

pub fn add_rect(&self, rect: &Self) -> Self

Get the smallest Rect that contains both rectangles self and rect.

Example

use iron_shapes::prelude::*;

let r1 = Rect::new((0,0), (1,2));
let r2 = Rect::new((4,5), (6,7));

let r3 = r1.add_rect(&r2);

assert_eq!(r3, Rect::new((0,0), (6,7)));

Trait Implementations

impl<T: CoordinateType> BoundingBox<T> for Rect<T>

fn bounding_box(&self) -> Rect<T>

Get bounding box of rectangle (which is equal to the rectangle itself).

impl<T: Clone> Clone for Rect<T> where
    T: CoordinateType, 

fn clone(&self) -> Rect<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 Rect<T> where
    T: CoordinateType, 

impl<T: Debug> Debug for Rect<T> where
    T: CoordinateType, 

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

Formats the value using the given formatter.

impl<T: CoordinateType> DoubledOrientedArea<T> for Rect<T>

fn area_doubled_oriented(&self) -> T

Calculate doubled oriented area of rectangle.

impl<T: Eq> Eq for Rect<T> where
    T: CoordinateType, 

impl<T> From<&'_ Rect<T>> for Polygon<T> where
    T: CoordinateType, 

Create a polygon from a rectangle.

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

Performs the conversion.

impl<T: CoordinateType> From<Rect<T>> for SimpleRPolygon<T>

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

Performs the conversion.

impl<T> From<Rect<T>> for Polygon<T> where
    T: CoordinateType, 

Create a polygon from a rectangle.

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

Performs the conversion.

impl<T: CoordinateType> From<Rect<T>> for Geometry<T>

fn from(x: Rect<T>) -> Geometry<T>

Performs the conversion.

impl<T: Hash> Hash for Rect<T> where
    T: CoordinateType, 

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<'a, T> IntoIterator for &'a Rect<T> where
    T: CoordinateType, 

Iterate over all points of the rectangle. Starts with the lower left corner and iterates counter clock-wise.

type Item = Point<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> MapPointwise<T> for Rect<T> where
    T: CoordinateType, 

Point wise transformation of the two corner points.

fn transform<F>(&self, transformation: F) -> Self where
    F: Fn(Point<T>) -> Point<T>, 

Point wise transformation.

impl<T: PartialEq> PartialEq<Rect<T>> for Rect<T> where
    T: CoordinateType, 

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

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

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

This method tests for !=.

impl<T> StructuralEq for Rect<T> where
    T: CoordinateType, 

impl<T> StructuralPartialEq for Rect<T> where
    T: CoordinateType, 

impl<T: CoordinateType> ToPolygon<T> for Rect<T>

fn to_polygon(&self) -> Polygon<T>

Convert the geometric object into a polygon.

impl<T: CoordinateType> TryBoundingBox<T> for Rect<T>

fn try_bounding_box(&self) -> Option<Rect<T>>

Get bounding box of rectangle (always exists).

impl<T: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for Rect<T>

type Output = Rect<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<Self::Output>

Try to cast to target data type.

fn cast(&self) -> Self::Output

Cast to target data type.