Struct geo_types::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.

Examples

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.

Examples

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

let exterior = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 1., y: 1. },
    Coordinate { x: 1., y: 0. },
    Coordinate { x: 0., y: 0. },
]);
let interiors = vec![LineString(vec![
    Coordinate { x: 0.1, y: 0.1 },
    Coordinate { x: 0.9, y: 0.9 },
    Coordinate { x: 0.9, y: 0.1 },
    Coordinate { x: 0.1, y: 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: PartialEq> PartialEq for Polygon<T> where     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: Clone> Clone for Polygon<T> where     T: 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> Debug for Polygon<T> where     T: CoordinateType,

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

Formats the value using the given formatter.

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

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

Performs the conversion.