logo
pub struct MultiPolygon<T = f64>(pub Vec<Polygon<T>, Global>) 
where
    T: CoordNum
;
Expand description

A collection of Polygons. Can be created from a Vec of Polygons, or from an Iterator which yields Polygons. Iterating over this object yields the component Polygons.

Semantics

The interior and the boundary are the union of the interior and the boundary of the constituent polygons.

Validity

  • The interiors of no two constituent polygons may intersect.

  • The boundaries of two (distinct) constituent polygons may only intersect at finitely many points.

Refer to section 6.1.14 of the OGC-SFA for a formal definition of validity. Note that the validity is not enforced, but expected by the operations and predicates that operate on it.

Tuple Fields

0: Vec<Polygon<T>, Global>

Implementations

Instantiate Self from the raw content value

Trait Implementations

Equality assertion with an absolute limit.

Examples
use geo_types::{polygon, Polygon, MultiPolygon};

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

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);

Used for specifying relative comparisons.

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

The inverse of [AbsDiffEq::abs_diff_eq].

Note. The implementation is a straight-forward summation of the signed areas of the individual polygons. In particular, unsigned_area is not necessarily the sum of the unsigned_area of the constituent polygons unless they are all oriented the same.

Return the BoundingRect for a MultiPolygon

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Find the closest point between self and p.

Return the number of coordinates in the MultiPolygon.

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

Iterate over all exterior coordinates of a geometry. Read more

Formats the value using the given formatter. Read more

MultiPolygon to Line distance

Returns the distance between two geometries Read more

Minimum distance from a Point to a MultiPolygon

Line to MultiPolygon distance

Returns the distance between two geometries Read more

Minimum distance from a MultiPolygon to a Point

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Creates a value from an iterator. Read more

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

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. Read more

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

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

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

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

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

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

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

👎 Deprecated since 0.21.0:

use MapCoordsInPlace::map_coords_in_place instead which takes a Coordinate instead of an (x,y) tuple

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

Examples
#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

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

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

This method tests for !=.

Equality assertion within a relative limit.

Examples
use geo_types::{polygon, Polygon, MultiPolygon};

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

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

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

The inverse of [RelativeEq::relative_eq].

Rotate the contained Polygons about their centroids by the given number of degrees

Rotate the MultiPolygon about the center of its bounding rectangle by the given number of degrees

👎 Deprecated:

Equivalent to rotate_around_centroid except for Polygon<T>, where it is equivalent to rotating around the polygon’s outer ring. Call that instead, or rotate_around_center if you’d like to rotate around the geometry’s bounding box center.

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

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

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

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.

The type returned in the event of a conversion error.

Performs the conversion.

👎 Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

👎 Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate instead of an (x,y) tuple

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

👎 Deprecated since 0.21.0:

use MapCoordsInPlace::try_map_coords_in_place which takes a Coordinate instead of an (x,y) tuple

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Rotate a Geometry around an arbitrary point by an angle, given in degrees Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Translate a Geometry along its axes by the given offsets Read more

Translate a Geometry along its axes, but in place.

👎 Deprecated since 0.20.1:

renamed to translate_in_place

Translate a Geometry along its axes, but in place.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.