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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
//! Integer coordinate polygons.
use serde::{Deserialize, Serialize};
use crate::bbox::Bbox;
use crate::contains::{Containment, Contains};
use crate::point::Point;
use crate::rect::Rect;
use crate::transform::{TransformMut, Transformation, TranslateMut};
use num_rational::Ratio;
/// A polygon, with vertex coordinates given
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct Polygon {
/// Vector of points that make up the polygon.
points: Vec<Point>,
}
impl Polygon {
/// Creates a polygon with given vertices.
pub fn from_verts(vec: Vec<Point>) -> Self {
Self { points: vec }
}
/// Returns the bottom y-coordinate in the polygon.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.bot(), 0);
/// ```
pub fn bot(&self) -> i64 {
self.points.iter().map(|point| point.y).min().unwrap()
}
/// Returns the top y-coordinate in the polygon.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.top(), 5);
/// ```
pub fn top(&self) -> i64 {
self.points.iter().map(|point| point.y).max().unwrap()
}
/// Returns the leftmost x-coordinate in the polygon.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.left(), -4);
/// ```
pub fn left(&self) -> i64 {
self.points.iter().map(|point| point.x).min().unwrap()
}
/// Returns the rightmost x-coordinate in the polygon.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.right(), 1);
/// ```
pub fn right(&self) -> i64 {
self.points.iter().map(|point| point.x).max().unwrap()
}
/// Returns a the vector of points representing the polygon.
pub fn points(&self) -> &Vec<Point> {
&self.points
}
/// Returns the center point of the polygon.
///
/// Returns a point with x-coordinate equal to the average of all x-coordinates
/// and y-coordinate equal to the average of all y-coordinates.
/// Note that the current behavior is to round down.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.center(), Point::new(-1, 2));
/// ```
pub fn center(&self) -> Point {
let x = self.points.iter().map(|point| point.x).sum::<i64>() / self.points.len() as i64;
let y = self.points.iter().map(|point| point.y).sum::<i64>() / self.points.len() as i64;
Point::new(x, y)
}
}
impl Bbox for Polygon {
fn bbox(&self) -> Option<Rect> {
let polygon = self;
Rect::from_sides_option(
polygon.left(),
polygon.bot(),
polygon.right(),
polygon.top(),
)
}
}
/// Helper function that checks if a point is contained within a triangle
fn triangle_contains(p: Point, v1: Point, v2: Point, v3: Point) -> bool {
let total_area = triangle_area(v1, v2, v3);
let sum_area = triangle_area(p, v2, v3) + triangle_area(v1, p, v3) + triangle_area(v1, v2, p);
sum_area == total_area
}
/// Helper function that finds the area of a given triangle
fn triangle_area(v1: Point, v2: Point, v3: Point) -> Ratio<i64> {
Ratio::new(
(v1.x * (v2.y - v3.y) + v2.x * (v3.y - v1.y) + v3.x * (v1.y - v2.y)).abs(),
2,
)
}
impl TranslateMut for Polygon {
fn translate_mut(&mut self, p: Point) {
self.points.translate_mut(p);
}
}
impl TransformMut for Polygon {
fn transform_mut(&mut self, trans: Transformation) {
self.points.transform_mut(trans);
}
}
impl Contains<Point> for Polygon {
/// Determines if a point is contained within a polygon.
///
/// # Example
///
/// ```
/// # use geometry::prelude::*;
/// let points = vec![
/// Point { x: -4, y: 0 },
/// Point { x: 0, y: 0 },
/// Point { x: 1, y: 2 },
/// Point { x: 2, y: 2 },
/// Point { x: -4, y: 5 },
/// ];
/// let p1 = Point::new(0,0);
/// let p2 = Point::new(0,4);
/// let p3 = Point::new(-5,3);
/// let p4 = Point::new(-2,4);
/// let p5 = Point::new(-2,2);
/// let polygon = Polygon::from_verts(points);
/// assert_eq!(polygon.contains(&p1), Containment::Full);
/// assert_eq!(polygon.contains(&p2), Containment::None);
/// assert_eq!(polygon.contains(&p3), Containment::None);
/// assert_eq!(polygon.contains(&p4), Containment::Full);
/// assert_eq!(polygon.contains(&p5), Containment::Full);
/// ```
fn contains(&self, p: &Point) -> Containment {
for (index, _) in self.points.iter().skip(1).enumerate() {
let v1 = self.points.first().unwrap();
let v2 = self.points.get(index).unwrap();
let v3 = self.points.get((index + 1) % self.points.len()).unwrap();
if triangle_contains(*p, *v1, *v2, *v3) {
return Containment::Full;
}
}
Containment::None
}
}