Struct geo::Polygon

pub struct Polygon<T> where
    T: CoordinateType,  {
    pub exterior: LineString<T>,
    pub interiors: Vec<LineString<T>>,
}

A representation of an area. Its outer boundary is represented by a LineString that is both closed and simple

It has one exterior ring or shell, and zero or more interior rings, representing holes.

Polygons can be created from collections of Point-like objects, such as arrays or tuples:

use geo_types::{Point, LineString, Polygon};
let poly1 = Polygon::new(vec![[0., 0.], [10., 0.]].into(), vec![]);
let poly2 = Polygon::new(vec![(0., 0.), (10., 0.)].into(), vec![]);

Fields

exterior: LineString<T>

interiors: Vec<LineString<T>>

Methods

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

pub fn new(exterior: LineString<T>, interiors: Vec<LineString<T>>) -> Polygon<T>

Creates a new polygon.

use geo_types::{Point, LineString, Polygon};

let exterior = LineString(vec![Point::new(0., 0.), Point::new(1., 1.),
                               Point::new(1., 0.), Point::new(0., 0.)]);
let interiors = vec![LineString(vec![Point::new(0.1, 0.1), Point::new(0.9, 0.9),
                                     Point::new(0.9, 0.1), Point::new(0.1, 0.1)])];
let p = Polygon::new(exterior.clone(), interiors.clone());
assert_eq!(p.exterior, exterior);
assert_eq!(p.interiors, interiors);

impl<T> Polygon<T> where     T: Float + Signed,

pub fn is_convex(&self) -> bool

Determine whether a Polygon is convex

Trait Implementations

impl<T> Clone for Polygon<T> where     T: Clone + CoordinateType,

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 for Polygon<T> where     T: Debug + CoordinateType,

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

Formats the value using the given formatter.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> From<Polygon<T>> for Geometry<T> where     T: CoordinateType,

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

Performs the conversion.

impl<T> Centroid<T> for Polygon<T> where     T: Float + FromPrimitive,

type Output = Option<Point<T>>

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

See: https://en.wikipedia.org/wiki/Centroid

impl<T> Contains<Point<T>> for Polygon<T> where     T: Float,

fn contains(&self, p: &Point<T>) -> bool

Checks if rhs is completely contained within self.

impl<T> Contains<Line<T>> for Polygon<T> where     T: Float,

fn contains(&self, line: &Line<T>) -> bool

Checks if rhs is completely contained within self.

impl<T> Contains<Polygon<T>> for Polygon<T> where     T: Float,

fn contains(&self, poly: &Polygon<T>) -> bool

Checks if rhs is completely contained within self.

impl<T> Contains<LineString<T>> for Polygon<T> where     T: Float,

fn contains(&self, linestring: &LineString<T>) -> bool

Checks if rhs is completely contained within self.

impl<T> Intersects<Polygon<T>> for Line<T> where     T: Float,

fn intersects(&self, p: &Polygon<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Line<T>> for Polygon<T> where     T: Float,

fn intersects(&self, line: &Line<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<LineString<T>> for Polygon<T> where     T: Float,

fn intersects(&self, linestring: &LineString<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Polygon<T>> for LineString<T> where     T: Float,

fn intersects(&self, polygon: &Polygon<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Polygon<T>> for Bbox<T> where     T: Float,

fn intersects(&self, polygon: &Polygon<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Bbox<T>> for Polygon<T> where     T: Float,

fn intersects(&self, bbox: &Bbox<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Polygon<T>> for Polygon<T> where     T: Float,

fn intersects(&self, polygon: &Polygon<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Area<T> for Polygon<T> where     T: Float,

fn area(&self) -> T

Area of polygon. See: https://en.wikipedia.org/wiki/Polygon

impl<T> EuclideanDistance<T, Polygon<T>> for Point<T> where     T: Float,

fn euclidean_distance(&self, polygon: &Polygon<T>) -> T

Minimum distance from a Point to a Polygon

impl<T> EuclideanDistance<T, Point<T>> for Polygon<T> where     T: Float,

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

Minimum distance from a Polygon to a Point

impl<T> EuclideanDistance<T, Polygon<T>> for LineString<T> where     T: Float + FloatConst + Signed + SpadeFloat,

LineString to Polygon

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Polygon<T> where     T: Float + FloatConst + Signed + SpadeFloat,

Polygon to LineString distance

fn euclidean_distance(&self, other: &LineString<T>) -> T

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Line<T> where     T: Float + Signed + SpadeFloat + FloatConst,

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Polygon<T> where     T: Float + FloatConst + Signed + SpadeFloat,

fn euclidean_distance(&self, other: &Line<T>) -> T

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Polygon<T> where     T: Float + FloatConst + SpadeFloat,

fn euclidean_distance(&self, poly2: &Polygon<T>) -> T

This implementation has a "fast path" in cases where both input polygons are convex: it switches to an implementation of the "rotating calipers" method described in Pirzadeh (1999), pp24—30, which is approximately an order of magnitude faster than the standard method.

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

type Output = Option<Bbox<T>>

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

Return the BoundingBox for a Polygon

impl<T> Simplify<T> for Polygon<T> where     T: Float,

fn simplify(&self, epsilon: &T) -> Polygon<T>

Returns the simplified representation of a geometry, using the Ramer–Douglas–Peucker algorithm

impl<T> SimplifyVWPreserve<T> for Polygon<T> where     T: Float + SpadeFloat,

fn simplifyvw_preserve(&self, epsilon: &T) -> Polygon<T>

Returns the simplified representation of a geometry, using a topology-preserving variant of the Visvalingam-Whyatt algorithm.

impl<T> SimplifyVW<T> for Polygon<T> where     T: Float,

fn simplifyvw(&self, epsilon: &T) -> Polygon<T>

Returns the simplified representation of a geometry, using the Visvalingam-Whyatt algorithm

impl<T> ConvexHull<T> for Polygon<T> where     T: Float,

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

Returns the convex hull of a Polygon. The hull is always oriented counter-clockwise.

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

fn orient(&self, direction: Direction) -> Polygon<T>

Orients a Polygon's exterior and interior rings according to convention

impl<T> ExtremeIndices<T> for Polygon<T> where     T: Float + Signed,

fn extreme_indices(&self) -> Result<Extremes, ()>

Find the extreme x and y indices of a convex Polygon

impl<T> Rotate<T> for Polygon<T> where     T: Float + FromPrimitive,

fn rotate(&self, angle: T) -> Self

Rotate the Polygon about its centroid by the given number of degrees

impl<T: CoordinateType, NT: CoordinateType> MapCoords<T, NT> for Polygon<T>

type Output = Polygon<NT>

fn map_coords(&self, func: &Fn(&(T, T)) -> (NT, NT)) -> Self::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

impl<T: CoordinateType, NT: CoordinateType> TryMapCoords<T, NT> for Polygon<T>

type Output = Polygon<NT>

fn try_map_coords(     &self,     func: &Fn(&(T, T)) -> Result<(NT, NT), Error> ) -> Result<Self::Output, Error>

Map a fallible function over all the coordinates in a geometry, returning a Result

impl<T: CoordinateType> MapCoordsInplace<T> for Polygon<T>

fn map_coords_inplace(&mut self, func: &Fn(&(T, T)) -> (T, T))

Apply a function to all the coordinates in a geometric object, in place

impl<F: Float> ClosestPoint<F> for Polygon<F>

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.