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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
use crate::{Coordinate, CoordinateType, Point}; /// A line segment made up of exactly two [`Point`s](struct.Point.html). #[derive(PartialEq, Clone, Copy, Debug)] #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] pub struct Line<T> where T: CoordinateType, { pub start: Coordinate<T>, pub end: Coordinate<T>, } impl<T> Line<T> where T: CoordinateType, { /// Creates a new line segment. /// /// # Examples /// /// ``` /// use geo_types::{Coordinate, Line}; /// /// let line = Line::new( /// Coordinate { x: 0., y: 0. }, /// Coordinate { x: 1., y: 2. }, /// ); /// /// assert_eq!(line.start, Coordinate { x: 0., y: 0. }); /// assert_eq!(line.end, Coordinate { x: 1., y: 2. }); /// ``` pub fn new<C>(start: C, end: C) -> Line<T> where C: Into<Coordinate<T>>, { Line { start: start.into(), end: end.into(), } } /// Calculate the difference in ‘x’ components (Δx). /// /// Equivalent to: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let line = Line::new( /// # Point(Coordinate { x: 4., y: -12. }), /// # Point(Coordinate { x: 0., y: 9. }), /// # ); /// # assert_eq!( /// # line.dx(), /// line.end.x - line.start.x /// # ); /// ``` pub fn dx(&self) -> T { self.end.x - self.start.x } /// Calculate the difference in ‘y’ components (Δy). /// /// Equivalent to: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let line = Line::new( /// # Point(Coordinate { x: 4., y: -12. }), /// # Point(Coordinate { x: 0., y: 9. }), /// # ); /// # assert_eq!( /// # line.dy(), /// line.end.y - line.start.y /// # ); /// ``` pub fn dy(&self) -> T { self.end.y - self.start.y } /// Calculate the slope (Δy/Δx). /// /// Equivalent to: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let line = Line::new( /// # Point(Coordinate { x: 4., y: -12. }), /// # Point(Coordinate { x: 0., y: 9. }), /// # ); /// # assert_eq!( /// # line.slope(), /// line.dy() / line.dx() /// # ); /// ``` /// /// Note that: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let a = Point(Coordinate { x: 4., y: -12. }); /// # let b = Point(Coordinate { x: 0., y: 9. }); /// # assert!( /// Line::new(a, b).slope() == /// Line::new(b, a).slope() /// # ); /// ``` pub fn slope(&self) -> T { self.dy() / self.dx() } /// Calculate the [determinant](https://en.wikipedia.org/wiki/Determinant) of the line. /// /// Equivalent to: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let line = Line::new( /// # Point(Coordinate { x: 4., y: -12. }), /// # Point(Coordinate { x: 0., y: 9. }), /// # ); /// # assert_eq!( /// # line.determinant(), /// line.start.x * line.end.y - /// line.start.y * line.end.x /// # ); /// ``` /// /// Note that: /// /// ```rust /// # use geo_types::{Line, Coordinate, Point}; /// # let a = Point(Coordinate { x: 4., y: -12. }); /// # let b = Point(Coordinate { x: 0., y: 9. }); /// # assert!( /// Line::new(a, b).determinant() == /// -Line::new(b, a).determinant() /// # ); /// ``` pub fn determinant(&self) -> T { self.start.x * self.end.y - self.start.y * self.end.x } pub fn start_point(&self) -> Point<T> { Point(self.start) } pub fn end_point(&self) -> Point<T> { Point(self.end) } pub fn points(&self) -> (Point<T>, Point<T>) { (self.start_point(), self.end_point()) } } impl<T: CoordinateType> From<[(T, T); 2]> for Line<T> { fn from(coord: [(T, T); 2]) -> Line<T> { Line::new(coord[0], coord[1]) } } #[cfg(feature = "rstar")] impl<T> ::rstar::RTreeObject for Line<T> where T: ::num_traits::Float + ::rstar::RTreeNum, { type Envelope = ::rstar::AABB<Point<T>>; fn envelope(&self) -> Self::Envelope { let bounding_rect = crate::private_utils::line_bounding_rect(*self); ::rstar::AABB::from_corners(bounding_rect.min.into(), bounding_rect.max.into()) } } #[cfg(feature = "rstar")] impl<T> ::rstar::PointDistance for Line<T> where T: ::num_traits::Float + ::rstar::RTreeNum, { fn distance_2(&self, point: &Point<T>) -> T { let d = crate::private_utils::point_line_euclidean_distance(*point, *self); d.powi(2) } }