use-rectangle 0.0.6

Rectangle primitives for the RustUse geometry workspace
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use use_bounds::Aabb2;
use use_point::Point2;

/// An axis-aligned rectangle.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Rectangle {
    bounds: Aabb2,
}

impl Rectangle {
    /// Creates a rectangle from any two corners.
    #[must_use]
    pub const fn from_corners(a: Point2, b: Point2) -> Self {
        Self {
            bounds: Aabb2::from_points(a, b),
        }
    }

    /// Creates a rectangle from bounds.
    #[must_use]
    pub const fn from_bounds(bounds: Aabb2) -> Self {
        Self { bounds }
    }

    /// Returns the underlying bounds.
    #[must_use]
    pub const fn bounds(self) -> Aabb2 {
        self.bounds
    }

    /// Returns the rectangle width.
    #[must_use]
    pub fn width(self) -> f64 {
        self.bounds.width()
    }

    /// Returns the rectangle height.
    #[must_use]
    pub fn height(self) -> f64 {
        self.bounds.height()
    }

    /// Returns the rectangle area.
    #[must_use]
    pub fn area(self) -> f64 {
        self.bounds.area()
    }

    /// Returns the rectangle center.
    #[must_use]
    pub const fn center(self) -> Point2 {
        self.bounds.center()
    }
}

#[cfg(test)]
mod tests {
    use super::Rectangle;
    use use_point::Point2;

    #[test]
    fn computes_rectangle_measurements() {
        let rectangle = Rectangle::from_corners(Point2::new(0.0, 0.0), Point2::new(4.0, 2.0));

        assert_eq!(rectangle.width(), 4.0);
        assert_eq!(rectangle.height(), 2.0);
        assert_eq!(rectangle.area(), 8.0);
        assert_eq!(rectangle.center(), Point2::new(2.0, 1.0));
    }
}