Struct Polygon

pub struct Polygon<T = f64>
where
    T: CoordNum,
{ /* private fields */ }

A bounded two-dimensional area.

A Polygon’s outer boundary (exterior ring) is represented by a LineString. It may contain zero or more holes (interior rings), also represented by LineStrings.

A Polygon can be created with the Polygon::new constructor or the polygon! macro.

Semantics

The boundary of the polygon is the union of the boundaries of the exterior and interiors. The interior is all the points inside the polygon (not on the boundary).

The Polygon structure guarantees that all exterior and interior rings will be closed, such that the first and last Coord of each ring has the same value.

Validity

• The exterior and interior rings must be valid LinearRings (see LineString).

• No two rings in the boundary may cross, and may intersect at a Point only as a tangent. In other words, the rings must be distinct, and for every pair of common points in two of the rings, there must be a neighborhood (a topological open set) around one that does not contain the other point.

• The closure of the interior of the Polygon must equal the Polygon itself. For instance, the exterior may not contain a spike.

• The interior of the polygon must be a connected point-set. That is, any two distinct points in the interior must admit a curve between these two that lies in the interior.

Refer to section 6.1.11.1 of the OGC-SFA for a formal definition of validity. Besides the closed LineString guarantee, the Polygon structure does not enforce validity at this time. For example, it is possible to construct a Polygon that has:

• fewer than 3 coordinates per LineString ring
• interior rings that intersect other interior rings
• interior rings that extend beyond the exterior ring

LineString closing operation

Some APIs on Polygon result in a closing operation on a LineString. The operation is as follows:

If a LineString’s first and last Coord have different values, a new Coord will be appended to the LineString with a value equal to the first Coord.

Implementations

impl<T> Polygon<T>

where T: CoordNum,

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

Create a new Polygon with the provided exterior LineString ring and interior LineString rings.

Upon calling new, the exterior and interior LineString rings will be closed.

Examples

Creating a Polygon with no interior rings:

use geo_types::{LineString, Polygon};

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

Creating a Polygon with an interior ring:

use geo_types::{LineString, Polygon};

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])],
);

If the first and last Coords of the exterior or interior LineStrings no longer match, those LineStrings will be closed:

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

let mut polygon = Polygon::new(LineString::from(vec![(0., 0.), (1., 1.), (1., 0.)]), vec![]);

assert_eq!(
    polygon.exterior(),
    &LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.),])
);

pub fn into_inner(self) -> (LineString<T>, Vec<LineString<T>>)

Consume the Polygon, returning the exterior LineString ring and a vector of the interior LineString rings.

Examples

use geo_types::{LineString, Polygon};

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])],
);

let (exterior, interiors) = polygon.into_inner();

assert_eq!(
    exterior,
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.),])
);

assert_eq!(
    interiors,
    vec![LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])]
);

pub fn exterior(&self) -> &LineString<T>

Return a reference to the exterior LineString ring.

Examples

use geo_types::{LineString, Polygon};

let exterior = LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]);

let polygon = Polygon::new(exterior.clone(), vec![]);

assert_eq!(polygon.exterior(), &exterior);

pub fn exterior_mut<F>(&mut self, f: F)

where F: FnOnce(&mut LineString<T>),

Execute the provided closure f, which is provided with a mutable reference to the exterior LineString ring.

After the closure executes, the exterior LineString will be closed.

Examples

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

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

polygon.exterior_mut(|exterior| {
    exterior.0[1] = coord! { x: 1., y: 2. };
});

assert_eq!(
    polygon.exterior(),
    &LineString::from(vec![(0., 0.), (1., 2.), (1., 0.), (0., 0.),])
);

If the first and last Coords of the exterior LineString no longer match, the LineString will be closed:

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

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

polygon.exterior_mut(|exterior| {
    exterior.0[0] = coord! { x: 0., y: 1. };
});

assert_eq!(
    polygon.exterior(),
    &LineString::from(vec![(0., 1.), (1., 1.), (1., 0.), (0., 0.), (0., 1.),])
);

pub fn try_exterior_mut<F, E>(&mut self, f: F) -> Result<(), E>

where F: FnOnce(&mut LineString<T>) -> Result<(), E>,

Fallible alternative to exterior_mut.

pub fn interiors(&self) -> &[LineString<T>]

Return a slice of the interior LineString rings.

Examples

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

let interiors = vec![LineString::from(vec![
    (0.1, 0.1),
    (0.9, 0.9),
    (0.9, 0.1),
    (0.1, 0.1),
])];

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    interiors.clone(),
);

assert_eq!(interiors, polygon.interiors());

pub fn interiors_mut<F>(&mut self, f: F)

where F: FnOnce(&mut [LineString<T>]),

Execute the provided closure f, which is provided with a mutable reference to the interior LineString rings.

After the closure executes, each of the interior LineStrings will be closed.

Examples

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

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])],
);

polygon.interiors_mut(|interiors| {
    interiors[0].0[1] = coord! { x: 0.8, y: 0.8 };
});

assert_eq!(
    polygon.interiors(),
    &[LineString::from(vec![
        (0.1, 0.1),
        (0.8, 0.8),
        (0.9, 0.1),
        (0.1, 0.1),
    ])]
);

If the first and last Coords of any interior LineString no longer match, those LineStrings will be closed:

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

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])],
);

polygon.interiors_mut(|interiors| {
    interiors[0].0[0] = coord! { x: 0.1, y: 0.2 };
});

assert_eq!(
    polygon.interiors(),
    &[LineString::from(vec![
        (0.1, 0.2),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
        (0.1, 0.2),
    ])]
);

pub fn try_interiors_mut<F, E>(&mut self, f: F) -> Result<(), E>

where F: FnOnce(&mut [LineString<T>]) -> Result<(), E>,

Fallible alternative to interiors_mut.

pub fn interiors_push(&mut self, new_interior: impl Into<LineString<T>>)

Add an interior ring to the Polygon.

The new LineString interior ring will be closed:

Examples

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

let mut polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

assert_eq!(polygon.interiors().len(), 0);

polygon.interiors_push(vec![(0.1, 0.1), (0.9, 0.9), (0.9, 0.1)]);

assert_eq!(
    polygon.interiors(),
    &[LineString::from(vec![
        (0.1, 0.1),
        (0.9, 0.9),
        (0.9, 0.1),
        (0.1, 0.1),
    ])]
);

pub fn num_rings(&self) -> usize

Count the total number of rings (interior and exterior) in the polygon

Examples

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

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

assert_eq!(polygon.num_rings(), 1);

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![(0.1, 0.1), (0.9, 0.9), (0.9, 0.1)])],
);

assert_eq!(polygon.num_rings(), 2);

pub fn num_interior_rings(&self) -> usize

Count the number of interior rings in the polygon

Examples

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

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![],
);

assert_eq!(polygon.num_interior_rings(), 0);

let polygon = Polygon::new(
    LineString::from(vec![(0., 0.), (1., 1.), (1., 0.), (0., 0.)]),
    vec![LineString::from(vec![(0.1, 0.1), (0.9, 0.9), (0.9, 0.1)])],
);

assert_eq!(polygon.num_interior_rings(), 1);

impl<T> Polygon<T>

where T: CoordFloat + Signed,

pub fn is_convex(&self) -> bool

👎Deprecated since 0.6.1: Please use geo::is_convex on poly.exterior() instead

Determine whether a Polygon is convex

Trait Implementations

impl<T> AbsDiffEq for Polygon<T>

where T: AbsDiffEq<Epsilon = T> + CoordNum,

fn abs_diff_eq( &self, other: &Polygon<T>, epsilon: <Polygon<T> as AbsDiffEq>::Epsilon, ) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{Polygon, polygon};

let a: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)];
let b: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)];

approx::assert_abs_diff_eq!(a, b, epsilon=0.1);
approx::assert_abs_diff_ne!(a, b, epsilon=0.001);

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> <Polygon<T> as AbsDiffEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T> Area<T> for Polygon<T>

where T: CoordFloat,

Note. The implementation handles polygons whose holes do not all have the same orientation. The sign of the output is the same as that of the exterior shell.

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T: BoolOpsNum> BooleanOps for Polygon<T>

type Scalar = T

fn rings(&self) -> impl Iterator<Item = &LineString<Self::Scalar>>

The exterior and interior rings of the geometry.

fn boolean_op( &self, other: &impl BooleanOps<Scalar = Self::Scalar>, op: OpType, ) -> MultiPolygon<Self::Scalar>

fn intersection( &self, other: &impl BooleanOps<Scalar = Self::Scalar>, ) -> MultiPolygon<Self::Scalar>

fn union( &self, other: &impl BooleanOps<Scalar = Self::Scalar>, ) -> MultiPolygon<Self::Scalar>

fn xor( &self, other: &impl BooleanOps<Scalar = Self::Scalar>, ) -> MultiPolygon<Self::Scalar>

fn difference( &self, other: &impl BooleanOps<Scalar = Self::Scalar>, ) -> MultiPolygon<Self::Scalar>

fn clip( &self, multi_line_string: &MultiLineString<Self::Scalar>, invert: bool, ) -> MultiLineString<Self::Scalar>

Clip a 1-D geometry with self.

impl<T> BoundingRect<T> for Polygon<T>

where T: CoordNum,

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

Return the BoundingRect for a Polygon

type Output = Option<Rect<T>>

impl<T> Centroid for Polygon<T>

where T: GeoFloat,

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

The Centroid of a Polygon is the mean of its points

Examples

use geo::Centroid;
use geo::{polygon, point};

let polygon = polygon![
    (x: 0.0f32, y: 0.0),
    (x: 2.0, y: 0.0),
    (x: 2.0, y: 1.0),
    (x: 0.0, y: 1.0),
];

assert_eq!(
    Some(point!(x: 1.0, y: 0.5)),
    polygon.centroid(),
);

type Output = Option<Point<T>>

impl<T> ChaikinSmoothing<T> for Polygon<T>

where T: CoordFloat + FromPrimitive,

fn chaikin_smoothing(&self, n_iterations: usize) -> Self

create a new geometry with the Chaikin smoothing being applied n_iterations times.

impl<T> ChamberlainDuquetteArea<T> for Polygon<T>

where T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

impl<T> Clone for Polygon<T>

where T: Clone + CoordNum,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Find the closest point between self and p.

impl<T> ConcaveHull for Polygon<T>

where T: GeoFloat + RTreeNum,

type Scalar = T

fn concave_hull(&self, concavity: Self::Scalar) -> Polygon<Self::Scalar>

impl<T> Contains<Coord<T>> for Polygon<T>

where T: GeoNum,

fn contains(&self, coord: &Coord<T>) -> bool

impl<T> Contains<Geometry<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, geometry: &Geometry<T>) -> bool

impl<T> Contains<GeometryCollection<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &GeometryCollection<T>) -> bool

impl<T> Contains<Line<T>> for Polygon<T>

where T: GeoFloat,

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

impl<T> Contains<LineString<T>> for Polygon<T>

where T: GeoFloat,

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

impl<T> Contains<MultiLineString<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &MultiLineString<T>) -> bool

impl<T> Contains<MultiPoint<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPoint<T>) -> bool

impl<T> Contains<MultiPolygon<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> bool

impl<T> Contains<Point<T>> for Polygon<T>

where T: GeoNum,

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

impl<F> Contains<Polygon<F>> for MultiPolygon<F>

where F: GeoFloat,

fn contains(&self, rhs: &Polygon<F>) -> bool

impl<T> Contains<Polygon<T>> for Geometry<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for GeometryCollection<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for Line<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for LineString<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for MultiLineString<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<Polygon<T>> for Point<T>

where T: CoordNum,

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

impl<T> Contains<Polygon<T>> for Rect<T>

where T: CoordFloat,

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

impl<T> Contains<Polygon<T>> for Triangle<T>

where T: GeoFloat,

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

impl<T> Contains<Rect<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &Rect<T>) -> bool

impl<T> Contains<Triangle<T>> for Polygon<T>

where T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> Contains for Polygon<T>

where T: GeoFloat,

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

impl<T> CoordinatePosition for Polygon<T>

where T: GeoNum,

type Scalar = T

fn calculate_coordinate_position( &self, coord: &Coord<T>, is_inside: &mut bool, boundary_count: &mut usize, )

fn coordinate_position(&self, coord: &Coord<Self::Scalar>) -> CoordPos

impl<T: CoordNum> CoordsIter for Polygon<T>

fn coords_count(&self) -> usize

Return the number of coordinates in the Polygon.

type Iter<'a> = Chain<Copied<Iter<'a, Coord<T>>>, Flatten<MapCoordsIter<'a, T, Iter<'a, LineString<T>>, LineString<T>>>> where T: 'a

type ExteriorIter<'a> = Copied<Iter<'a, Coord<T>>> where T: 'a

type Scalar = T

fn coords_iter(&self) -> Self::Iter<'_>

Iterate over all exterior and (if any) interior coordinates of a geometry.

fn exterior_coords_iter(&self) -> Self::ExteriorIter<'_>

Iterate over all exterior coordinates of a geometry.

impl<T> Debug for Polygon<T>

where T: Debug + CoordNum,

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

Formats the value using the given formatter.

impl<F: CoordFloat + FromPrimitive> Densify<F> for Polygon<F>

type Output = Polygon<F>

fn densify<MetricSpace>(&self, max_segment_length: F) -> Self::Output

where MetricSpace: Distance<F, Point<F>, Point<F>> + InterpolatePoint<F>,

impl<T> DensifyHaversine<T> for Polygon<T>

where T: CoordFloat + FromPrimitive, Line<T>: HaversineLength<T>, LineString<T>: HaversineLength<T>,

type Output = Polygon<T>

👎Deprecated since 0.29.0: Please use the line.densify::<Haversine>() via the Densify trait instead.

fn densify_haversine(&self, max_distance: T) -> Self::Output

👎Deprecated since 0.29.0: Please use the line.densify::<Haversine>() via the Densify trait instead.

impl<F> Distance<F, &Geometry<F>, &Polygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Geometry<F>, b: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &GeometryCollection<F>, &Polygon<F>> for Euclidean

fn distance( iter_geometry: &GeometryCollection<F>, to_geometry: &Polygon<F>, ) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Line<F>, &Polygon<F>> for Euclidean

fn distance(line: &Line<F>, polygon: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &LineString<F>, &Polygon<F>> for Euclidean

fn distance(line_string: &LineString<F>, polygon: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiLineString<F>, &Polygon<F>> for Euclidean

fn distance(iter_geometry: &MultiLineString<F>, to_geometry: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPoint<F>, &Polygon<F>> for Euclidean

fn distance(iter_geometry: &MultiPoint<F>, to_geometry: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Polygon<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Point<F>, &Polygon<F>> for Euclidean

fn distance(point: &Point<F>, polygon: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Polygon<F>, &Geometry<F>> for Euclidean

fn distance(origin: &Polygon<F>, destination: &Geometry<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &GeometryCollection<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &GeometryCollection<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &Line<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &LineString<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &LineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &MultiLineString<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &MultiLineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &MultiPoint<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &MultiPoint<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &Point<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &Point<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Polygon<F>, &Polygon<F>> for Euclidean

fn distance(polygon_a: &Polygon<F>, polygon_b: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &Rect<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &Rect<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &Triangle<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &Triangle<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Rect<F>, &Polygon<F>> for Euclidean

fn distance(polygonlike: &Rect<F>, geometry_b: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &Triangle<F>, &Polygon<F>> for Euclidean

fn distance(polygonlike: &Triangle<F>, geometry_b: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<T> EuclideanDistance<T> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Geometry<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, geom: &Geometry<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, GeometryCollection<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &GeometryCollection<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for Polygon<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Polygon<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

Polygon to LineString distance

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiLineString<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiLineString<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPoint<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiPoint<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, target: &MultiPolygon<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for Polygon<T>

where T: GeoFloat,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Minimum distance from a Polygon to a Point

impl<T> EuclideanDistance<T, Polygon<T>> for Geometry<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for GeometryCollection<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Line<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for LineString<T>

where T: GeoFloat + FloatConst + Signed + RTreeNum,

LineString to Polygon

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for MultiLineString<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for MultiPoint<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Point<T>

where T: GeoFloat,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Minimum distance from a Point to a Polygon

impl<T> EuclideanDistance<T, Polygon<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for Triangle<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Rect<T>> for Polygon<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Triangle<T>> for Polygon<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<'a, F: GeoFloat> From<&'a Polygon<F>> for PreparedGeometry<'a, F>

fn from(polygon: &'a Polygon<F>) -> Self

Converts to this type from the input type.

impl<'a, F: GeoFloat> From<Polygon<F>> for PreparedGeometry<'a, F>

fn from(polygon: Polygon<F>) -> Self

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

impl<T: GeoNum> From<Polygon<T>> for MonotonicPolygons<T>

fn from(poly: Polygon<T>) -> Self

Converts to this type from the input type.

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

where T: CoordNum,

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

Converts to this type from the input type.

impl<T> From<Triangle<T>> for Polygon<T>

where T: CoordNum,

fn from(t: Triangle<T>) -> Polygon<T>

Converts to this type from the input type.

impl GeodesicArea<f64> for Polygon

fn geodesic_perimeter(&self) -> f64

Determine the perimeter of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_signed(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth.

fn geodesic_area_unsigned(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter_area_signed(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

impl<C: CoordNum> HasDimensions for Polygon<C>

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

impl<T> Hash for Polygon<T>

where T: Hash + CoordNum,

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> HaversineClosestPoint<T> for Polygon<T>

where T: GeoFloat + FromPrimitive,

fn haversine_closest_point(&self, from: &Point<T>) -> Closest<T>

impl<T> InteriorPoint for Polygon<T>

where T: GeoFloat,

type Output = Option<Point<T>>

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

Calculates a representative point inside the Geometry

impl<T> Intersects<Coord<T>> for Polygon<T>

where T: GeoNum,

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

impl<T> Intersects<Geometry<T>> for Polygon<T>

where Geometry<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &Geometry<T>) -> bool

impl<T> Intersects<GeometryCollection<T>> for Polygon<T>

where GeometryCollection<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &GeometryCollection<T>) -> bool

impl<T> Intersects<Line<T>> for Polygon<T>

where T: GeoNum,

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

impl<T> Intersects<LineString<T>> for Polygon<T>

where LineString<T>: Intersects<Polygon<T>>, T: CoordNum,

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

impl<T> Intersects<MultiLineString<T>> for Polygon<T>

where MultiLineString<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiLineString<T>) -> bool

impl<T> Intersects<MultiPoint<T>> for Polygon<T>

where MultiPoint<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPoint<T>) -> bool

impl<T> Intersects<MultiPolygon<T>> for Polygon<T>

where MultiPolygon<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &MultiPolygon<T>) -> bool

impl<T> Intersects<Point<T>> for Polygon<T>

where Point<T>: Intersects<Polygon<T>>, T: CoordNum,

fn intersects(&self, rhs: &Point<T>) -> bool

impl<T> Intersects<Polygon<T>> for Coord<T>

where Polygon<T>: Intersects<Coord<T>>, T: CoordNum,

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

impl<T> Intersects<Polygon<T>> for Line<T>

where Polygon<T>: Intersects<Line<T>>, T: CoordNum,

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

impl<T> Intersects<Polygon<T>> for Rect<T>

where Polygon<T>: Intersects<Rect<T>>, T: CoordNum,

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

impl<T> Intersects<Polygon<T>> for Triangle<T>

where Polygon<T>: Intersects<Triangle<T>>, T: CoordNum,

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

impl<T> Intersects<Rect<T>> for Polygon<T>

where T: GeoNum,

fn intersects(&self, rect: &Rect<T>) -> bool

impl<T> Intersects<Triangle<T>> for Polygon<T>

where T: GeoNum,

fn intersects(&self, rect: &Triangle<T>) -> bool

impl<T> Intersects for Polygon<T>

where T: GeoNum,

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

impl<'a, T: CoordNum + 'a> LinesIter<'a> for Polygon<T>

type Scalar = T

type Iter = Chain<LineStringIter<'a, <Polygon<T> as LinesIter<'a>>::Scalar>, Flatten<MapLinesIter<'a, Iter<'a, LineString<<Polygon<T> as LinesIter<'a>>::Scalar>>, LineString<<Polygon<T> as LinesIter<'a>>::Scalar>>>>

fn lines_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior lines of a geometry.

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

type Output = Polygon<NT>

fn map_coords( &self, func: impl Fn(Coord<T>) -> Coord<NT> + Copy, ) -> Self::Output

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

fn try_map_coords<E>( &self, func: impl Fn(Coord<T>) -> Result<Coord<NT>, E> + Copy, ) -> Result<Self::Output, E>

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

impl<T: CoordNum> MapCoordsInPlace<T> for Polygon<T>

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<T> + Copy)

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

fn try_map_coords_in_place<E>( &mut self, func: impl Fn(Coord<T>) -> Result<Coord<T>, E>, ) -> Result<(), E>

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

impl<T> Orient for Polygon<T>

where T: GeoNum,

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

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

impl<T> PartialEq for Polygon<T>

where T: PartialEq + CoordNum,

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> RTreeObject for Polygon<T>

where T: Float + RTreeNum,

type Envelope = AABB<Point<T>>

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the object’s dimensionality.

fn envelope(&self) -> <Polygon<T> as RTreeObject>::Envelope

Returns the object’s envelope.

impl<F: GeoFloat> Relate<F> for Polygon<F>

fn geometry_graph(&self, arg_index: usize) -> GeometryGraph<'_, F>

Construct a GeometryGraph

fn relate(&self, other: &impl Relate<F>) -> IntersectionMatrix

impl<T> RelativeEq for Polygon<T>

where T: AbsDiffEq<Epsilon = T> + CoordNum + RelativeEq,

fn relative_eq( &self, other: &Polygon<T>, epsilon: <Polygon<T> as AbsDiffEq>::Epsilon, max_relative: <Polygon<T> as AbsDiffEq>::Epsilon, ) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{Polygon, polygon};

let a: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)];
let b: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)];

approx::assert_relative_eq!(a, b, max_relative=0.1);
approx::assert_relative_ne!(a, b, max_relative=0.001);

fn default_max_relative() -> <Polygon<T> as AbsDiffEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T> RemoveRepeatedPoints<T> for Polygon<T>

where T: CoordNum + FromPrimitive,

fn remove_repeated_points(&self) -> Self

Create a Polygon with consecutive repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove consecutive repeated points from a Polygon inplace.

impl<T> Simplify<T> for Polygon<T>

where T: GeoFloat,

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

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

impl<T> SimplifyVw<T> for Polygon<T>

where T: CoordFloat,

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

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

impl<T> SimplifyVwPreserve<T> for Polygon<T>

where T: GeoFloat + RTreeNum,

fn simplify_vw_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: CoordFloat> TriangulateEarcut<T> for Polygon<T>

fn earcut_triangles_raw(&self) -> RawTriangulation<T>

Return the raw result from the earcutr library: a one-dimensional vector of polygon vertices (in XY order), and the indices of the triangles within the vertices vector. This method is less ergonomic than the earcut_triangles and earcut_triangles_iter methods, but can be helpful when working in graphics contexts that expect flat vectors of data.

fn earcut_triangles(&self) -> Vec<Triangle<T>>

Examples

fn earcut_triangles_iter(&self) -> Iter<T>

Examples

impl<T> TryFrom<Geometry<T>> for Polygon<T>

where T: CoordNum,

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( geom: Geometry<T>, ) -> Result<Polygon<T>, <Polygon<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T> Eq for Polygon<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for Polygon<T>

where T: CoordNum,