Struct Polygon

pub struct Polygon<T> {
    pub exterior: SimplePolygon<T>,
    pub interiors: Vec<SimplePolygon<T>>,
}

A polygon possibly with holes. The polygon is defined by a hull and a list of holes which are both SimplePolygons.

Fields

exterior: SimplePolygon<T>

The outer hull of the polygon.

interiors: Vec<SimplePolygon<T>>

A list of holes in the polygon.

Implementations

impl<T> Polygon<T>

pub fn new_raw(exterior: Vec<Point<T>>) -> Polygon<T>

Create a new polygon from a sequence of points. Ordering of points is not normalized. This impacts the equality check.

pub fn new_raw_with_holes<E, I>(exterior: E, holes: Vec<I>) -> Polygon<T>

where E: Into<SimplePolygon<T>>, I: Into<SimplePolygon<T>>,

Create a new polygon from a hull and a list of holes. Ordering of points is not normalized. This impacts the equality check.

pub fn empty() -> Polygon<T>

Create empty polygon without any vertices.

pub fn len(&self) -> usize

Get the number of vertices.

pub fn is_empty(&self) -> bool

Check if polygon has no vertices.

impl<T> Polygon<T>

where T: Copy,

pub fn edges(&self) -> Vec<Edge<T>>

Get all exterior edges of the polygon.

pub fn all_edges_iter(&self) -> impl Iterator<Item = Edge<T>>

Iterate over all edges of the polygon, including interior edges.

impl<T> Polygon<T>

where T: PartialOrd,

pub fn new<I>(i: I) -> Polygon<T>

where I: Into<Polygon<T>>,

Create a new polygon from a sequence of points.

pub fn new_with_holes<E, I>(exterior: E, holes: Vec<I>) -> Polygon<T>

where E: Into<SimplePolygon<T>>, I: Into<SimplePolygon<T>>,

Create a new polygon from a hull and a list of holes.

pub fn normalize(&mut self)

Reorder vertices and holes to get the lexicographically smallest representation of this polygon. Does not change the orientations.

pub fn normalized(self) -> Polygon<T>

Reorder vertices and holes to get the lexicographically smallest representation of this polygon. Does not change the orientations.

impl<T> Polygon<T>

where T: CoordinateType,

pub fn convex_hull(&self) -> SimplePolygon<T>

where T: Ord,

Get the convex hull of the polygon.

Implements Andrew’s Monotone Chain algorithm. See: http://geomalgorithms.com/a10-_hull-1.html

pub fn lower_left_vertex(&self) -> Point<T>

Get the vertex with lowest x-coordinate of the exterior polygon. Prefer lower y-coordinates to break ties.

Examples

use iron_shapes::polygon::Polygon;
use iron_shapes::point::Point;
let coords = vec![(0, 0), (1, 0), (-1, 2), (-1, 1)];

let poly = Polygon::new(coords);

assert_eq!(poly.lower_left_vertex(), Point::new(-1, 1));

pub fn orientation<Area>(&self) -> Orientation

where Area: Num + From<T> + PartialOrd,

Get the orientation of the exterior polygon.

Examples

use iron_shapes::polygon::Polygon;
use iron_shapes::point::Point;
use iron_shapes::types::Orientation;
let coords = vec![(0, 0), (3, 0), (3, 1)];

let poly = Polygon::new(coords);

assert_eq!(poly.orientation::<i64>(), Orientation::CounterClockWise);

Trait Implementations

impl BooleanOp<Ratio<i32>> for Polygon<Ratio<i32>>

fn boolean_op( &self, operation: Operation, other: &Polygon<Ratio<i32>>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<Ratio<i32>>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl BooleanOp<Ratio<i64>> for Polygon<Ratio<i64>>

fn boolean_op( &self, operation: Operation, other: &Polygon<Ratio<i64>>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<Ratio<i64>>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl BooleanOp<f32> for Polygon<f32>

fn boolean_op( &self, operation: Operation, other: &Polygon<f32>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<f32>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl BooleanOp<f64> for Polygon<f64>

fn boolean_op( &self, operation: Operation, other: &Polygon<f64>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<f64>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl BooleanOp<i32> for Polygon<i32>

fn boolean_op( &self, operation: Operation, other: &Polygon<i32>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<i32>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl BooleanOp<i64> for Polygon<i64>

fn boolean_op( &self, operation: Operation, other: &Polygon<i64>, polygon_semantics: PolygonSemantics, ) -> MultiPolygon<i64>

Compute the boolean operation of self and other.

fn intersection(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean intersection self & other.

fn difference(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean difference self - other.

fn union(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean union self | other.

fn xor(&self, other: &Self) -> MultiPolygon<T>

Compute the boolean exclusive OR self ^ other.

impl<T> Clone for Polygon<T>

where T: Clone,

fn clone(&self) -> Polygon<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Polygon<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Polygon<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Polygon<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, A> DoubledOrientedArea<A> for Polygon<T>

where T: CoordinateType, A: Num + From<T>,

fn area_doubled_oriented(&self) -> A

Calculates the doubled oriented area.

Using doubled area allows to compute in the integers because the area of a polygon with integer coordinates is either integer or half-integer.

The area will be positive if the vertices are listed counter-clockwise, negative otherwise.

Complexity: O(n)

Examples

use iron_shapes::polygon::{Polygon, DoubledOrientedArea};
let coords = vec![(0, 0), (3, 0), (3, 1)];

let poly = Polygon::new(coords);

let area: i64 = poly.area_doubled_oriented();
assert_eq!(area, 3);

impl<T> From<&Rect<T>> for Polygon<T>

where T: Copy,

Create a polygon from a rectangle.

fn from(rect: &Rect<T>) -> Polygon<T>

Converts to this type from the input type.

impl<T> From<&SimplePolygon<T>> for Polygon<T>

where T: Copy,

Create a polygon from a simple polygon.

fn from(simple_polygon: &SimplePolygon<T>) -> Polygon<T>

Converts to this type from the input type.

impl<'a, T, P> From<&'a Vec<P>> for Polygon<T>

where T: CoordinateType, Point<T>: From<&'a P>,

Create a polygon from a Vec of values convertible to Points.

fn from(vec: &'a Vec<P>) -> Polygon<T>

Converts to this type from the input type.

impl<T> From<Geometry<T>> for Polygon<T>

where T: CoordinateType + NumCast,

fn from(g: Geometry<T>) -> Polygon<T>

Convert a geometry into a polygon.

impl<T> From<Polygon<T>> for Geometry<T>

fn from(x: Polygon<T>) -> Geometry<T>

Converts to this type from the input type.

impl<T> From<Rect<T>> for Polygon<T>

where T: Copy,

Create a polygon from a rectangle.

fn from(rect: Rect<T>) -> Polygon<T>

Converts to this type from the input type.

impl<T> From<SimplePolygon<T>> for Polygon<T>

Create a polygon from a simple polygon.

fn from(simple_polygon: SimplePolygon<T>) -> Polygon<T>

Converts to this type from the input type.

impl<T, P> From<Vec<P>> for Polygon<T>

where T: Copy + PartialOrd, Point<T>: From<P>,

Create a polygon from a Vec of values convertible to Points.

fn from(vec: Vec<P>) -> Polygon<T>

Converts to this type from the input type.

impl<T, P> FromIterator<P> for Polygon<T>

where T: Copy, P: Into<Point<T>>,

Create a polygon from a iterator of values convertible to Points.

fn from_iter<I>(iter: I) -> Polygon<T>

where I: IntoIterator<Item = P>,

Creates a value from an iterator.

impl<T> Hash for Polygon<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> MapPointwise<T> for Polygon<T>

where T: CoordinateType,

fn transform<F>(&self, tf: F) -> Polygon<T>

where F: Fn(Point<T>) -> Point<T>,

Point wise transformation.

impl<T> PartialEq for Polygon<T>

where T: PartialEq,

fn eq(&self, other: &Polygon<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

impl<T> Serialize for Polygon<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryBoundingBox<T> for Polygon<T>

where T: Copy + PartialOrd,

fn try_bounding_box(&self) -> Option<Rect<T>>

Return the bounding box of this geometry if a bounding box is defined.

impl<T, Dst> TryCastCoord<T, Dst> for Polygon<T>

where T: CoordinateType + NumCast, Dst: CoordinateType + NumCast,

type Output = Polygon<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<<Polygon<T> as TryCastCoord<T, Dst>>::Output>

Try to cast to target data type.

fn cast(&self) -> Self::Output

Cast to target data type.

impl<T> WindingNumber<T> for Polygon<T>

where T: CoordinateType,

fn winding_number(&self, point: Point<T>) -> isize

Calculate the winding number of the polygon around this point.

TODO: Define how point on edges and vertices is handled.

See: http://geomalgorithms.com/a03-_inclusion.html

fn contains_point_non_oriented(&self, point: Point<T>) -> bool

Check if point is inside the polygon, i.e. the polygons winds around the point a non-zero number of times.

fn contains_point(&self, point: Point<T>) -> bool

Check if point is inside the polygon, i.e. the polygon winds around the point an odd number of times.

impl<T> Eq for Polygon<T>

where T: Eq,

impl<T> StructuralPartialEq for Polygon<T>