Struct fyrox_math::Rect

pub struct Rect<T> {
    pub position: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>,
    pub size: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>,
}

A rectangle defined by position and size.

Fields

position: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

Position of the rectangle.

size: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

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) -> Rect<T>

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

pub fn with_position( self, position: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>> ) -> Rect<T>

Sets the new position of the rectangle.

pub fn with_size( self, size: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>> ) -> Rect<T>

Sets the new size of the rectangle.

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

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) -> Rect<T>

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: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>> ) -> bool

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

pub fn center(&self) -> Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

Returns center point of the rectangle.

pub fn push(&mut self, p: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>)

Extends the rectangle to contain the given point.

Notes

To build bounding rectangle you should correctly initialize initial rectangle:

let vertices = [Vector2::new(1.0, 2.0), Vector2::new(-3.0, 5.0)];

// This is important part, it must have "invalid" state to correctly
// calculate bounding rect. Rect::default will give invalid result!
let mut bounding_rect = Rect::new(f32::MAX, f32::MAX, 0.0, 0.0);

for &v in &vertices {
    bounding_rect.push(v);
}

pub fn clip_by(&self, other: Rect<T>) -> Rect<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 this rectangle.

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

Checks if the rectangle intersects with some other rectangle.

pub fn translate( &self, translation: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>> ) -> Rect<T>

Offsets the given rectangle and returns a new rectangle.

pub fn intersects_circle( &self, center: Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>, 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>)

Extends the rectangle so it will contain the other rectangle.

pub fn left_top_corner( &self ) -> Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

Returns the top left corner of the rectangle.

pub fn right_top_corner( &self ) -> Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

Returns the top right corner of the rectangle.

pub fn right_bottom_corner( &self ) -> Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

Returns the bottom right corner of the rectangle.

pub fn left_bottom_corner( &self ) -> Matrix<T, Const<2>, Const<1>, ArrayStorage<T, 2, 1>>

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: &Matrix<T, Const<3>, Const<3>, ArrayStorage<T, 3, 3>> ) -> Rect<T>

Applies an arbitrary affine transformation to the rectangle.

Trait Implementations

impl<T> Clone for Rect<T>

where T: Clone,

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 for Rect<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Rect<T>

where T: Number,

fn default() -> Rect<T>

Returns the “default value” for a type.

impl<T> PartialEq for Rect<T>

where T: PartialEq,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for Rect<T>

where T: Copy,

impl<T> Eq for Rect<T>

where T: Eq,

impl<T> StructuralPartialEq for Rect<T>