Struct Rect 

pub struct Rect {
    pub x: f64,
    pub y: f64,
    pub width: f64,
    pub height: f64,
}

Defines a rectangle.

Fields

x: f64

The X position.

y: f64

The Y position.

width: f64

The width.

height: f64

The height.

Implementations

impl Rect

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

Initializes a new instance of the Rect structure.

pub const fn from_size(size: Size) -> Self

Initializes a Rect at the origin with the given size.

pub const fn from_position_size(position: Point, size: Size) -> Self

Initializes a Rect from its position and size.

pub fn from_points(top_left: Point, bottom_right: Point) -> Self

Initializes a Rect from its top left and bottom right corners.

pub const fn position(&self) -> Point

Gets the position of the rectangle.

pub const fn size(&self) -> Size

Gets the size of the rectangle.

pub fn right(&self) -> f64

Gets the right position of the rectangle.

pub fn bottom(&self) -> f64

Gets the bottom position of the rectangle.

pub const fn left(&self) -> f64

Gets the left position.

pub const fn top(&self) -> f64

Gets the top position.

pub const fn top_left(&self) -> Point

Gets the top left point of the rectangle.

pub fn top_right(&self) -> Point

Gets the top right point of the rectangle.

pub fn bottom_left(&self) -> Point

Gets the bottom left point of the rectangle.

pub fn bottom_right(&self) -> Point

Gets the bottom right point of the rectangle.

pub fn center(&self) -> Point

Gets the center point of the rectangle.

pub fn contains(&self, p: Point) -> bool

Determines whether a point is in the bounds of the rectangle (edges inclusive).

pub fn contains_exclusive(&self, p: Point) -> bool

Determines whether a point is in the bounds of the rectangle, exclusive of the rectangle’s bottom/right edge.

pub fn contains_rect(&self, r: Rect) -> bool

Determines whether the rectangle fully contains another rectangle.

pub fn center_rect(&self, rect: Rect) -> Rect

Centers another rectangle in this rectangle.

pub fn inflate(&self, thickness: f64) -> Rect

Inflates the rectangle by the same amount on every side.

pub fn inflate_thickness(&self, thickness: Thickness) -> Rect

Inflates the rectangle.

pub fn deflate(&self, thickness: f64) -> Rect

Deflates the rectangle by the same amount on every side.

pub fn deflate_thickness(&self, thickness: Thickness) -> Rect

Deflates the rectangle by a Thickness. The deflated rectangle size cannot be less than 0.

pub fn equals(&self, other: Rect) -> bool

Returns a boolean indicating whether the rect is equal to the other given rect (exact comparison).

pub fn intersect(&self, rect: Rect) -> Rect

Gets the intersection of two rectangles, or an empty (default) rectangle if they do not overlap.

pub fn intersects(&self, rect: Rect) -> bool

Determines whether a rectangle intersects with this rectangle.

pub fn transform_to_aabb(&self, matrix: Matrix) -> Rect

Returns the axis-aligned bounding box of a transformed rectangle.

pub fn translate(&self, offset: Vector) -> Rect

Translates the rectangle by an offset.

pub fn normalize(&self) -> Rect

Normalizes the rectangle so both the width and height are positive, without changing its location: positive-size rects are returned unchanged, negative sizes are flipped. A rect with any NaN edge becomes the default rect.

pub fn union(&self, rect: Rect) -> Rect

Gets the union of two rectangles. A rectangle whose width and height are both zero is ignored.

pub fn union_optional(left: Option<Rect>, right: Option<Rect>) -> Option<Rect>

Union of two optional rectangles; a missing side yields the other side.

pub const fn with_x(&self, x: f64) -> Rect

Returns a new Rect with the specified X position.

pub const fn with_y(&self, y: f64) -> Rect

Returns a new Rect with the specified Y position.

pub const fn with_width(&self, width: f64) -> Rect

Returns a new Rect with the specified width.

pub const fn with_height(&self, height: f64) -> Rect

Returns a new Rect with the specified height.

pub fn parse(s: &str) -> Result<Self, FormatError>

Parses a Rect string ("x, y, width, height").

pub fn is_empty(&self) -> bool

This method should be used internally to check for the rect emptiness. Once a dedicated “empty” value exists this is the single place to update.

Trait Implementations

impl BatchValue for Rect

fn write_to(&self, out: &mut Vec<u8>)

fn read_from(input: &mut BatchValueReader<'_>) -> Self

impl Clone for Rect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rect

impl Debug for Rect

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

Formats the value using the given formatter.

impl Default for Rect

fn default() -> Self

Returns the “default value” for a type.

impl Display for Rect

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

Formats the value using the given formatter.

impl Div<Vector> for Rect

Divides a rectangle by a vector.

type Output = Rect

The resulting type after applying the / operator.

fn div(self, scale: Vector) -> Rect

Performs the / operation.

impl DivAssign<Vector> for Rect

fn div_assign(&mut self, scale: Vector)

Performs the /= operation.

impl From<Rect> for RoundedRect

fn from(r: Rect) -> RoundedRect

Converts to this type from the input type.

impl FromStr for Rect

type Err = FormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FormatError>

Parses a string s to return a value of this type.

impl MarkupTyped for Rect

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl Mul<Vector> for Rect

Multiplies a rectangle by a scaling vector.

type Output = Rect

The resulting type after applying the * operator.

fn mul(self, scale: Vector) -> Rect

Performs the * operation.

impl Mul<f64> for Rect

Multiplies a rectangle by a scale.

type Output = Rect

The resulting type after applying the * operator.

fn mul(self, scale: f64) -> Rect

Performs the * operation.

impl MulAssign<Vector> for Rect

fn mul_assign(&mut self, scale: Vector)

Performs the *= operation.

impl MulAssign<f64> for Rect

fn mul_assign(&mut self, scale: f64)

Performs the *= operation.

impl PartialEq for Rect

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Rect