Struct nannou::geom::rect::Rect

pub struct Rect<S = f64> {
    pub x: Range<S>,
    pub y: Range<S>,
}

Defines a Rectangle's bounds across the x and y axes.

Fields

x: Range<S>

The start and end positions of the Rectangle on the x axis.

y: Range<S>

The start and end positions of the Rectangle on the y axis.

Methods

impl<S> Rect<S> where
    S: BaseNum, 

fn from_xy_wh(p: Point2<S>, wh: Vector2<S>) -> Self

Construct a Rect from a given Point and Dimensions.

fn from_corners(a: Point2<S>, b: Point2<S>) -> Self

Construct a Rect from the coordinates of two points.

fn overlap(self, other: Self) -> Option<Self>

The Rect representing the area in which two Rects overlap.

fn max(self, other: Self) -> Self where
    S: Float, 

The Rect that encompass the two given sets of Rect.

fn x(&self) -> S

The position in the middle of the x bounds.

fn y(&self) -> S

The position in the middle of the y bounds.

fn xy(&self) -> Point2<S>

The xy position in the middle of the bounds.

fn x_y(&self) -> (S, S)

The centered x and y coordinates as a tuple.

fn bottom(&self) -> S

The Rect's lowest y value.

fn top(&self) -> S

The Rect's highest y value.

fn left(&self) -> S

The Rect's lowest x value.

fn right(&self) -> S

The Rect's highest x value.

fn top_left(&self) -> Point2<S>

The top left corner Point.

fn bottom_left(&self) -> Point2<S>

The bottom left corner Point.

fn top_right(&self) -> Point2<S>

The top right corner Point.

fn bottom_right(&self) -> Point2<S>

The bottom right corner Point.

fn l_r_b_t(&self) -> (S, S, S, S)

The edges of the Rect in a tuple (top, bottom, left, right).

fn shift_x(self, x: S) -> Self

Shift the Rect along the x axis.

fn shift_y(self, y: S) -> Self

Shift the Rect along the y axis.

fn shift(self, p: Point2<S>) -> Self

Shift the Rect by the given Point.

fn contains(&self, p: Point2<S>) -> bool

Does the given point touch the Rectangle.

fn stretch_to_point(self, point: Point2<S>) -> Self

Stretches the closest edge(s) to the given point if the point lies outside of the Rect area.

fn left_of(self, other: Self) -> Self

Align self's right edge with the left edge of the other Rect.

fn right_of(self, other: Self) -> Self

Align self's left edge with the right dge of the other Rect.

fn below(self, other: Self) -> Self

Align self's top edge with the bottom edge of the other Rect.

fn above(self, other: Self) -> Self

Align self's bottom edge with the top edge of the other Rect.

fn align_x_of(self, align: Align, other: Self) -> Self

Align self to other along the x axis in accordance with the given Align variant.

fn align_y_of(self, align: Align, other: Self) -> Self

Align self to other along the y axis in accordance with the given Align variant.

fn align_left_of(self, other: Self) -> Self

Align self's left edge with the left edge of the other Rect.

fn align_middle_x_of(self, other: Self) -> Self

Align the middle of self with the middle of the other Rect along the x axis.

fn align_right_of(self, other: Self) -> Self

Align self's right edge with the right edge of the other Rect.

fn align_bottom_of(self, other: Self) -> Self

Align self's bottom edge with the bottom edge of the other Rect.

fn align_middle_y_of(self, other: Self) -> Self

Align the middle of self with the middle of the other Rect along the y axis.

fn align_top_of(self, other: Self) -> Self

Align self's top edge with the top edge of the other Rect.

fn top_left_of(self, other: Self) -> Self

Place self along the top left edges of the other Rect.

fn top_right_of(self, other: Self) -> Self

Place self along the top right edges of the other Rect.

fn bottom_left_of(self, other: Self) -> Self

Place self along the bottom left edges of the other Rect.

fn bottom_right_of(self, other: Self) -> Self

Place self along the bottom right edges of the other Rect.

fn mid_top_of(self, other: Self) -> Self

Place self in the middle of the top edge of the other Rect.

fn mid_bottom_of(self, other: Self) -> Self

Place self in the middle of the bottom edge of the other Rect.

fn mid_left_of(self, other: Self) -> Self

Place self in the middle of the left edge of the other Rect.

fn mid_right_of(self, other: Self) -> Self

Place self in the middle of the right edge of the other Rect.

fn middle_of(self, other: Self) -> Self

Place self directly in the middle of the other Rect.

fn closest_corner(&self, p: Point2<S>) -> Corner

Return the Corner of self that is closest to the given Point.

fn corners(&self) -> [Point2<S>; 4]

Thee four corners of the Rect.

fn triangles(&self) -> (Tri<Point2<S>>, Tri<Point2<S>>)

Return two Tris that represent the Rect.

impl<S> Rect<S> where
    S: BaseNum + Neg<Output = S>, 

fn w(&self) -> S

The width of the Rect.

fn h(&self) -> S

The height of the Rect.

fn wh(&self) -> Vector2<S>

The total dimensions of the Rect.

fn w_h(&self) -> (S, S)

The width and height of the Rect as a tuple.

fn xy_wh(&self) -> (Point2<S>, Vector2<S>)

Convert the Rect to a Point and Dimensions.

fn x_y_w_h(&self) -> (S, S, S, S)

The Rect's centered coordinates and dimensions in a tuple.

fn len(&self) -> S

The length of the longest side of the rectangle.

fn l_t_w_h(&self) -> (S, S, S, S)

The left and top edges of the Rect along with the width and height.

fn l_b_w_h(&self) -> (S, S, S, S)

The left and bottom edges of the Rect along with the width and height.

fn pad_left(self, pad: S) -> Self

The Rect with some padding applied to the left edge.

fn pad_right(self, pad: S) -> Self

The Rect with some padding applied to the right edge.

fn pad_bottom(self, pad: S) -> Self

The rect with some padding applied to the bottom edge.

fn pad_top(self, pad: S) -> Self

The Rect with some padding applied to the top edge.

fn pad(self, pad: S) -> Self

The Rect with some padding amount applied to each edge.

fn padding(self, padding: Padding<S>) -> Self

The Rect with some padding applied.

fn relative_to_x(self, x: S) -> Self

Returns a Rect with a position relative to the given position on the x axis.

fn relative_to_y(self, y: S) -> Self

Returns a Rect with a position relative to the given position on the y axis.

fn relative_to(self, p: Point2<S>) -> Self

Returns a Rect with a position relative to the given position.

Trait Implementations

impl<S: Copy> Copy for Rect<S>

impl<S: Clone> Clone for Rect<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Rect<S>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for Rect<S>

fn eq(&self, __arg_0: &Rect<S>) -> bool

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

fn ne(&self, __arg_0: &Rect<S>) -> bool

This method tests for !=.