bdrk_geometry 0.0.4

Geometry Helpers
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! 2D Point
//!
//! This module contains basic methods to manipulate a 2D point

/// Generic 2D Point
#[derive(Copy, Clone, Debug, Default)]
pub struct Point2D {
    x: f32,
    y: f32,
}

impl Point2D {
    /// Create Generic 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let new_point = Point2D::new(0f32, 0f32);
    ///
    /// assert_eq!(new_point.x(), &0f32);
    /// assert_eq!(new_point.y(), &0f32);
    /// ```
    pub fn new(x: f32, y: f32) -> Self {
        Point2D { x, y }
    }

    /// Create Generic 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let mut new_point = Point2D::new(0f32, 0f32);
    ///
    /// new_point.set(1f32, 1f32);
    ///
    /// assert_eq!(new_point.x(), &1f32);
    /// assert_eq!(new_point.y(), &1f32);
    /// ```
    pub fn set(&mut self, x: f32, y: f32) {
        self.x = x;
        self.y = y;
    }

    /// Gets X coordinate reference of 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let new_point = Point2D::new(0f32, 0f32);
    ///
    /// assert_eq!(new_point.x(), &0f32);
    /// ```
    pub fn x(&self) -> &f32 {
        &self.x
    }

    /// Gets Y coordinate reference of 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let new_point = Point2D::new(0f32, 0f32);
    ///
    /// assert_eq!(new_point.y(), &0f32);
    /// ```
    pub fn y(&self) -> &f32 {
        &self.y
    }

    /// Gets mutable X coordinate reference of 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let mut new_point = Point2D::new(0f32, 0f32);
    ///
    /// *new_point.x_mut() = 2f32;
    ///
    /// assert_eq!(new_point.x(), &2f32);
    /// ```
    pub fn x_mut(&mut self) -> &mut f32 {
        &mut self.x
    }

    /// Gets mutable Y coordinate reference of 2D Point
    ///
    /// # Examples
    ///
    /// ```
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let mut new_point = Point2D::new(0f32, 0f32);
    ///
    /// *new_point.y_mut() = 2f32;
    ///
    /// assert_eq!(new_point.y(), &2f32);
    /// ```
    pub fn y_mut(&mut self) -> &mut f32 {
        &mut self.y
    }

    /// Gets distance to another point from existing point
    ///
    /// # Examples
    ///
    /// ```
    /// use std::f32::consts::SQRT_2;
    /// use bdrk_geometry::mod_2d::Point2D;
    ///
    /// let new_point = Point2D::new(0f32, 0f32);
    /// let target_point = Point2D::new(1f32, 1f32);
    ///
    /// assert_eq!(new_point.distance_to(&target_point), SQRT_2);
    /// ```
    pub fn distance_to(&self, other: &Point2D) -> f32 {
        let delta_x = self.x() + other.x();
        let delta_y = self.y() + other.y();

        (delta_x.powi(2) + delta_y.powi(2)).sqrt()
    }
}

impl PartialEq<Self> for Point2D {
    fn eq(&self, other: &Self) -> bool {
        self.x == other.x && self.y == other.y
    }
}

impl Eq for Point2D { }