Struct Rect 

pub struct Rect<T: Coord = i32> { /* private fields */ }

Rectangle defined by left, top, right and bottom coordinates.

The left and top coordinates are inclusive. The right and bottom coordinates are exclusive.

Implementations

impl<T: Coord> Rect<T>

pub fn new(top_left: Point<T>, bottom_right: Point<T>) -> Rect<T>

pub fn width(&self) -> T

pub fn height(&self) -> T

pub fn top(&self) -> T

pub fn left(&self) -> T

pub fn right(&self) -> T

pub fn bottom(&self) -> T

pub fn corners(&self) -> [Point<T>; 4]

Return the corners of the rect in clockwise order, starting from the top left.

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

Return the coordinate of the top-left corner of the rect.

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

Return the coordinate of the top-right corner of the rect.

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

Return the coordinate of the bottom-left corner of the rect.

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

Return the coordinate of the bottom-right corner of the rect.

pub fn left_edge(&self) -> Line<T>

Return the line segment of the left edge of the rect.

pub fn top_edge(&self) -> Line<T>

Return the line segment of the top edge of the rect.

pub fn right_edge(&self) -> Line<T>

Return the line segment of the right edge of the rect.

pub fn bottom_edge(&self) -> Line<T>

Return the line segment of the bottom edge of the rect.

pub fn tlbr(&self) -> [T; 4]

Return the top, left, bottom and right coordinates as an array.

pub fn from_hw(height: T, width: T) -> Rect<T>

Return a rect with top-left corner at 0, 0 and the given height/width.

pub fn from_tlbr(top: T, left: T, bottom: T, right: T) -> Rect<T>

Return a rect with the given top, left, bottom and right coordinates.

pub fn from_tlhw(top: T, left: T, height: T, width: T) -> Rect<T>

Return a rect with the given top, left, height and width.

pub fn area(&self) -> T

where T: Mul<Output = T>,

Return the signed area of this rect.

pub fn tlhw(&self) -> [T; 4]

Return the top, left, height and width as an array.

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

Return true if other lies on the boundary or interior of this rect.

pub fn is_empty(&self) -> bool

Return true if the width or height of this rect are <= 0.

pub fn adjust_tlbr(&self, top: T, left: T, bottom: T, right: T) -> Rect<T>

Return a new Rect with each coordinate adjusted by an offset.

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

Return true if the intersection of this rect and other is non-empty.

pub fn union(&self, other: Rect<T>) -> Rect<T>

Return the smallest rect that contains both this rect and other.

pub fn intersection(&self, other: Rect<T>) -> Rect<T>

Return the largest rect that is contained within this rect and other.

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

Return true if other lies entirely within this rect.

pub fn clamp(&self, rect: Rect<T>) -> Rect<T>

Return a new with each side adjusted so that the result lies inside rect.

pub fn to_polygon(&self) -> Polygon<T, [Point<T>; 4]>

impl Rect<i32>

pub fn center(&self) -> Point

Return the center point of the rect.

pub fn iou(&self, other: Rect) -> f32

Return the Intersection over Union ratio for this rect and other.

See https://en.wikipedia.org/wiki/Jaccard_index.

pub fn to_f32(&self) -> RectF

impl Rect<f32>

pub fn center(&self) -> PointF

Return the center point of the rect.

pub fn iou(&self, other: RectF) -> f32

Return the Intersection over Union ratio for this rect and other.

See https://en.wikipedia.org/wiki/Jaccard_index.

pub fn integral_bounding_rect(&self) -> Rect<i32>

Return the smallest rect with integral coordinates that contains this rect.

Trait Implementations

impl<T: Coord> BoundingRect for Rect<T>

type Coord = T

Coordinate type of bounding rect.

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

Return the smallest axis-aligned bounding rect which contains this shape.

impl<T: Clone + Coord> Clone for Rect<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Coord> Debug for Rect<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Coord> PartialEq for Rect<T>

fn eq(&self, other: &Rect<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: Copy + Coord> Copy for Rect<T>

impl<T: Eq + Coord> Eq for Rect<T>

impl<T: Coord> StructuralPartialEq for Rect<T>