Struct geo::MultiPolygon

pub struct MultiPolygon<T>(pub Vec<Polygon<T>, Global>)
 where
    T: CoordNum;

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.

Implementations

impl<T> MultiPolygon<T> where
    T: CoordNum, 

pub fn iter(&self) -> impl Iterator<Item = &Polygon<T>>

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Polygon<T>>

Trait Implementations

impl<T> Area<T> for MultiPolygon<T> where
    T: CoordFloat, 

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.

pub fn signed_area(&self) -> T

pub fn unsigned_area(&self) -> T

impl<T> BoundingRect<T> for MultiPolygon<T> where
    T: CoordNum, 

type Output = Option<Rect<T>>

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

Return the BoundingRect for a MultiPolygon

impl<T> Centroid for MultiPolygon<T> where
    T: CoordFloat + FromPrimitive + Sum, 

type Output = Option<Point<T>>

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

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

impl<T> Clone for MultiPolygon<T> where
    T: Clone + CoordNum, 

pub fn clone(&self) -> MultiPolygon<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: GeoFloat> ClosestPoint<F, Point<F>> for MultiPolygon<F>

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

Find the closest point between self and p.

impl<T> ConcaveHull for MultiPolygon<T> where
    T: GeoFloat + RTreeNum, 

type Scalar = T

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

impl<G, T> Contains<G> for MultiPolygon<T> where
    T: CoordNum,
    Polygon<T>: Contains<G>, 

pub fn contains(&self, rhs: &G) -> bool

impl<T> ConvexHull for MultiPolygon<T> where
    T: GeoNum, 

type Scalar = T

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

impl<T> CoordinatePosition for MultiPolygon<T> where
    T: GeoNum, 

type Scalar = T

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

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

impl<'a, T: CoordNum + 'a> CoordsIter<'a> for MultiPolygon<T>

type Iter = Flatten<MapCoordsIter<'a, T, Iter<'a, Polygon<T>>, Polygon<T>>>

type ExteriorIter = Flatten<MapExteriorCoordsIter<'a, T, Iter<'a, Polygon<T>>, Polygon<T>>>

type Scalar = T

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

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

pub fn coords_count(&'a self) -> usize

Return the number of coordinates in the MultiPolygon.

pub fn exterior_coords_iter(&'a self) -> Self::ExteriorIter

Iterate over all exterior coordinates of a geometry.

impl<T> Debug for MultiPolygon<T> where
    T: Debug + CoordNum, 

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

Formats the value using the given formatter.

impl<T> Eq for MultiPolygon<T> where
    T: Eq + CoordNum, 

impl<T> EuclideanDistance<T, Line<T>> for MultiPolygon<T> where
    T: GeoFloat + FloatConst + Signed + RTreeNum, 

MultiPolygon to Line distance

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Point<T> where
    T: GeoFloat, 

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

Minimum distance from a Point to a MultiPolygon

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Line<T> where
    T: GeoFloat + FloatConst + Signed + RTreeNum, 

Line to MultiPolygon distance

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for MultiPolygon<T> where
    T: GeoFloat, 

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

Minimum distance from a MultiPolygon to a Point

impl<T, IP> From<IP> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

pub fn from(x: IP) -> MultiPolygon<T>

Performs the conversion.

impl<T> From<MultiPolygon<T>> for Geometry<T> where
    T: CoordNum, 

pub fn from(x: MultiPolygon<T>) -> Geometry<T>

Performs the conversion.

impl<T, IP> From<Vec<IP, Global>> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

pub fn from(x: Vec<IP, Global>) -> MultiPolygon<T>

Performs the conversion.

impl<T, IP> FromIterator<IP> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

pub fn from_iter<I>(iter: I) -> MultiPolygon<T> where
    I: IntoIterator<Item = IP>, 

Creates a value from an iterator.

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

pub fn is_empty(&self) -> bool

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

pub 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.

pub fn boundary_dimensions(&self) -> Dimensions

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

impl<T> Hash for MultiPolygon<T> where
    T: Hash + CoordNum, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<G, T> Intersects<G> for MultiPolygon<T> where
    T: GeoNum,
    Polygon<T>: Intersects<G>, 

pub fn intersects(&self, rhs: &G) -> bool

impl<T> Intersects<MultiPolygon<T>> for Point<T> where
    MultiPolygon<T>: Intersects<Point<T>>,
    T: CoordNum, 

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

impl<T> Intersects<MultiPolygon<T>> for Line<T> where
    MultiPolygon<T>: Intersects<Line<T>>,
    T: CoordNum, 

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

impl<T> Intersects<MultiPolygon<T>> for Rect<T> where
    MultiPolygon<T>: Intersects<Rect<T>>,
    T: CoordNum, 

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

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

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

impl<'a, T> IntoIterator for &'a mut MultiPolygon<T> where
    T: CoordNum, 

type Item = &'a mut Polygon<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Polygon<T>>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a mut MultiPolygon<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a MultiPolygon<T> where
    T: CoordNum, 

type Item = &'a Polygon<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Polygon<T>>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a MultiPolygon<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for MultiPolygon<T> where
    T: CoordNum, 

type Item = Polygon<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Polygon<T>, Global>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <MultiPolygon<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

type Output = MultiPolygon<NT>

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

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

impl<T: CoordNum> MapCoordsInplace<T> for MultiPolygon<T>

pub fn map_coords_inplace(&mut self, func: impl Fn(&(T, T)) -> (T, T) + Copy)

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

impl<T> Orient for MultiPolygon<T> where
    T: GeoNum, 

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

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

impl<T> PartialEq<MultiPolygon<T>> for MultiPolygon<T> where
    T: PartialEq<T> + CoordNum, 

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

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

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

This method tests for !=.

impl<T> Rotate<T> for MultiPolygon<T> where
    T: CoordFloat + FromPrimitive + Sum, 

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

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

impl<T> Simplify<T, T> for MultiPolygon<T> where
    T: GeoFloat, 

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

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

impl<T> SimplifyVW<T, T> for MultiPolygon<T> where
    T: CoordFloat, 

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

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

impl<T> SimplifyVWPreserve<T, T> for MultiPolygon<T> where
    T: CoordFloat + RTreeNum, 

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

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

impl<T> StructuralEq for MultiPolygon<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for MultiPolygon<T> where
    T: CoordNum, 

impl<T> TryFrom<Geometry<T>> for MultiPolygon<T> where
    T: CoordNum, 

type Error = FailedToConvertError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T: CoordNum, NT: CoordNum> TryMapCoords<T, NT> for MultiPolygon<T>

type Output = MultiPolygon<NT>

pub fn try_map_coords(
    &self,
    func: impl Fn(&(T, T)) -> Result<(NT, NT), Box<dyn Error + Send + Sync>> + Copy
) -> Result<Self::Output, Box<dyn Error + Send + Sync>>

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