Struct Rect

pub struct Rect<T> {
    pub position: Vector2<T>,
    pub size: Vector2<T>,
}

A rectangle defined by position and size.

Fields

position: Vector2<T>

Position of the rectangle.

size: Vector2<T>

Size of the rectangle, where X - width, Y - height.

Implementations

impl<T> Rect<T>

where T: Number,

pub fn new(x: T, y: T, w: T, h: T) -> Self

Creates a new rectangle from X, Y, width, height.

pub fn from_points(p0: Vector2<T>, p1: Vector2<T>) -> Self

where T: SimdPartialOrd,

Create a new rectangle from two diagonally opposite corner points. In other words, create the smallest rectangle containing both given points.

pub fn with_position(self, position: Vector2<T>) -> Self

Sets the new position of the rectangle.

pub fn with_size(self, size: Vector2<T>) -> Self

Sets the new size of the rectangle.

pub fn inflate(&self, dw: T, dh: T) -> Self

Inflates the rectangle by the given amounts. It offsets the rectangle by (-dw, -dh) and increases its size by (2 * dw, 2 * dh).

pub fn deflate(&self, dw: T, dh: T) -> Self

Deflates the rectangle by the given amounts. It offsets the rectangle by (dw, dh) and decreases its size by (2 * dw, 2 * dh).

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

Checks if the given point lies within the bounds of the rectangle.

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

Returns center point of the rectangle.

pub fn push(&mut self, p: Vector2<T>)

where T: SimdPartialOrd,

Extends the rectangle to contain the given point.

Notes

To build bounding rectangle you should use OptionRect.

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

Clips the rectangle by some other rectangle and returns a new rectangle that corresponds to the intersection of both rectangles. If the rectangles does not intersects, the method returns none.

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

Checks if the rectangle intersects with some other rectangle.

pub fn translate(&self, translation: Vector2<T>) -> Self

Offsets the given rectangle and returns a new rectangle.

pub fn intersects_circle(&self, center: Vector2<T>, radius: T) -> bool

Checks if the rectangle intersects a circle represented by a center point and a radius.

pub fn extend_to_contain(&mut self, other: Rect<T>)

where T: SimdPartialOrd,

Extends the rectangle so it will contain the other rectangle.

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

Returns the top left corner of the rectangle.

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

Returns the top right corner of the rectangle.

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

Returns the bottom right corner of the rectangle.

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

Returns the bottom left corner of the rectangle.

pub fn w(&self) -> T

Returns width of the rectangle.

pub fn h(&self) -> T

Returns height of the rectangle.

pub fn x(&self) -> T

Returns horizontal position of the rectangle.

pub fn y(&self) -> T

Returns vertical position of the rectangle.

pub fn transform(&self, matrix: &Matrix3<T>) -> Self

Applies an arbitrary affine transformation to the rectangle.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for Rect<T>

where T: Number,

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<Rect<T>> for OptionRect<T>

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

Converts to this type from the input type.

impl<T: PartialEq> 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> Copy for Rect<T>

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

impl<T> StructuralPartialEq for Rect<T>