Struct iron_shapes::polygon::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 empty() -> Self

Create empty polygon without any vertices.

impl<T: Copy> Polygon<T>

pub fn len(&self) -> usize

Get the number of vertices.

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: CoordinateType> Polygon<T>

pub fn new<I>(i: I) -> Self where
    I: Into<Self>, 

Create a new polygon from a sequence of points.

pub fn new_with_holes<E, I>(exterior: E, holes: Vec<I>) -> Self where
    E: Into<SimplePolygon<T>>,
    I: Into<SimplePolygon<T>>, 

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

pub fn convex_hull(&self) -> Polygon<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<T: Clone> Clone for Polygon<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Polygon<T>

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

Formats the value using the given formatter.

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<'a, T, P> From<&'a Vec<P, Global>> 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>) -> Self

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>) -> Self

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>) -> Self

Converts to this type from the input type.

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>) -> Self

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>) -> Self

Converts to this type from the input type.

impl<T, P> From<Vec<P, Global>> for Polygon<T> where
    T: Copy,
    Point<T>: From<P>, 

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

fn from(vec: Vec<P>) -> Self

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) -> Self where
    I: IntoIterator<Item = P>, 

Creates a value from an iterator.

impl<T: Hash> Hash for Polygon<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: CoordinateType + NumCast> Into<Polygon<T>> for Geometry<T>

fn into(self) -> Polygon<T>

Convert a geometry into a polygon.

impl<T> MapPointwise<T> for Polygon<T> where
    T: CoordinateType, 

fn transform<F: Fn(Point<T>) -> Point<T>>(&self, tf: F) -> Self

Point wise transformation.

impl<T> PartialEq<Polygon<T>> for Polygon<T> where
    T: PartialEq, 

fn eq(&self, rhs: &Self) -> bool

Equality test for polygons.

Two polygons are equal iff a cyclic shift on their vertices can be applied such that the both lists of vertices match exactly.

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

This method tests for !=.

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: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for Polygon<T>

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<Self::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: PartialEq> Eq for Polygon<T>