[−][src]Struct geo::Polygon
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 LineString
s.
The Polygon
structure guarantees that all exterior and interior rings will
be closed, such that the first and last Coordinate
of each ring has
the same value.
Validity
Besides the closed LineString
rings 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 Coordinate
have different values, a
new Coordinate
will be appended to the LineString
with a value equal to
the first Coordinate
.
Implementations
impl<T> Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
pub fn new(exterior: LineString<T>, interiors: Vec<LineString<T>>) -> Polygon<T>
[src]
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 Coordinate
s of the exterior or interior
LineString
s no longer match, those LineString
s will be closed:
use geo_types::{Coordinate, 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>>)
[src]
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>
[src]
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: FnMut(&mut LineString<T>),
[src]
F: FnMut(&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::{Coordinate, 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] = Coordinate { x: 1., y: 2. }; }); assert_eq!( polygon.exterior(), &LineString::from(vec![(0., 0.), (1., 2.), (1., 0.), (0., 0.),]) );
If the first and last Coordinate
s of the exterior LineString
no
longer match, the LineString
will be closed:
use geo_types::{Coordinate, 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] = Coordinate { x: 0., y: 1. }; }); assert_eq!( polygon.exterior(), &LineString::from(vec![(0., 1.), (1., 1.), (1., 0.), (0., 0.), (0., 1.),]) );
pub fn interiors(&self) -> &[LineString<T>]
[src]
Return a slice of the interior LineString
rings.
Examples
use geo_types::{Coordinate, 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: FnMut(&mut [LineString<T>]),
[src]
F: FnMut(&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 LineString
s will be
closed.
Examples
use geo_types::{Coordinate, 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] = Coordinate { 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 Coordinate
s of any interior LineString
no
longer match, those LineString
s will be closed:
use geo_types::{Coordinate, 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] = Coordinate { 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 interiors_push(&mut self, new_interior: impl Into<LineString<T>>)
[src]
Add an interior ring to the Polygon
.
The new LineString
interior ring will be closed:
Examples
use geo_types::{Coordinate, 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), ])] );
impl<T> Polygon<T> where
T: Float + Signed,
[src]
T: Float + Signed,
Trait Implementations
impl<T> Area<T> for Polygon<T> where
T: Float,
[src]
T: Float,
fn signed_area(&self) -> T
[src]
fn unsigned_area(&self) -> T
[src]
impl<T> BoundingRect<T> for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
type Output = Option<Rect<T>>
fn bounding_rect(&self) -> Self::Output
[src]
Return the BoundingRect for a Polygon
impl<T> Centroid<T> for Polygon<T> where
T: Float + FromPrimitive + Sum,
[src]
T: Float + FromPrimitive + Sum,
impl<T> ChamberlainDuquetteArea<T> for Polygon<T> where
T: Float + CoordinateType,
[src]
T: Float + CoordinateType,
fn chamberlain_duquette_signed_area(&self) -> T
[src]
fn chamberlain_duquette_unsigned_area(&self) -> T
[src]
impl<T> Clone for Polygon<T> where
T: Clone + CoordinateType,
[src]
T: Clone + CoordinateType,
impl<F: Float> ClosestPoint<F, Point<F>> for Polygon<F>
[src]
fn closest_point(&self, p: &Point<F>) -> Closest<F>
[src]
impl<T> Contains<Coordinate<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn contains(&self, coord: &Coordinate<T>) -> bool
[src]
impl<T> Contains<Line<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
impl<T> Contains<LineString<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn contains(&self, linestring: &LineString<T>) -> bool
[src]
impl<T> Contains<Point<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
impl<T> Contains<Polygon<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
impl<T> ConvexHull<T> for Polygon<T> where
T: Float,
[src]
T: Float,
fn convex_hull(&self) -> Polygon<T>
[src]
impl<T> Debug for Polygon<T> where
T: Debug + CoordinateType,
[src]
T: Debug + CoordinateType,
impl<T> Eq for Polygon<T> where
T: Eq + CoordinateType,
[src]
T: Eq + CoordinateType,
impl<T> EuclideanDistance<T, Line<T>> for Polygon<T> where
T: Float + FloatConst + Signed + RTreeNum,
[src]
T: Float + FloatConst + Signed + RTreeNum,
fn euclidean_distance(&self, other: &Line<T>) -> T
[src]
impl<T> EuclideanDistance<T, LineString<T>> for Polygon<T> where
T: Float + FloatConst + Signed + RTreeNum,
[src]
T: Float + FloatConst + Signed + RTreeNum,
Polygon to LineString distance
fn euclidean_distance(&self, other: &LineString<T>) -> T
[src]
impl<T> EuclideanDistance<T, Point<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn euclidean_distance(&self, point: &Point<T>) -> T
[src]
Minimum distance from a Polygon to a Point
impl<T> EuclideanDistance<T, Polygon<T>> for Point<T> where
T: Float,
[src]
T: Float,
fn euclidean_distance(&self, polygon: &Polygon<T>) -> T
[src]
Minimum distance from a Point to a Polygon
impl<T> EuclideanDistance<T, Polygon<T>> for LineString<T> where
T: Float + FloatConst + Signed + RTreeNum,
[src]
T: Float + FloatConst + Signed + RTreeNum,
LineString to Polygon
fn euclidean_distance(&self, other: &Polygon<T>) -> T
[src]
impl<T> EuclideanDistance<T, Polygon<T>> for Line<T> where
T: Float + Signed + RTreeNum + FloatConst,
[src]
T: Float + Signed + RTreeNum + FloatConst,
fn euclidean_distance(&self, other: &Polygon<T>) -> T
[src]
impl<T> EuclideanDistance<T, Polygon<T>> for Polygon<T> where
T: Float + FloatConst + RTreeNum,
[src]
T: Float + FloatConst + RTreeNum,
fn euclidean_distance(&self, poly2: &Polygon<T>) -> T
[src]
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> ExtremeIndices<T> for Polygon<T> where
T: Float + Signed,
[src]
T: Float + Signed,
fn extreme_indices(&self) -> Result<Extremes, ()>
[src]
impl<T> From<Polygon<T>> for Geometry<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> From<Rect<T>> for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> From<Triangle<T>> for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> Hash for Polygon<T> where
T: Hash + CoordinateType,
[src]
T: Hash + CoordinateType,
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T> Intersects<Line<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, line: &Line<T>) -> bool
[src]
impl<T> Intersects<LineString<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, linestring: &LineString<T>) -> bool
[src]
impl<T> Intersects<Polygon<T>> for Line<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, p: &Polygon<T>) -> bool
[src]
impl<T> Intersects<Polygon<T>> for LineString<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, polygon: &Polygon<T>) -> bool
[src]
impl<T> Intersects<Polygon<T>> for Rect<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, polygon: &Polygon<T>) -> bool
[src]
impl<T> Intersects<Polygon<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, polygon: &Polygon<T>) -> bool
[src]
impl<T> Intersects<Rect<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
fn intersects(&self, bounding_rect: &Rect<T>) -> bool
[src]
impl<T: CoordinateType, NT: CoordinateType> MapCoords<T, NT> for Polygon<T>
[src]
type Output = Polygon<NT>
fn map_coords(&self, func: impl Fn(&(T, T)) -> (NT, NT) + Copy) -> Self::Output
[src]
impl<T: CoordinateType> MapCoordsInplace<T> for Polygon<T>
[src]
impl<T> Orient<T> for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> PartialEq<Polygon<T>> for Polygon<T> where
T: PartialEq<T> + CoordinateType,
[src]
T: PartialEq<T> + CoordinateType,
impl<T> Rotate<T> for Polygon<T> where
T: Float + FromPrimitive + Sum,
[src]
T: Float + FromPrimitive + Sum,
fn rotate(&self, angle: T) -> Self
[src]
Rotate the Polygon about its centroid by the given number of degrees
impl<T> Simplify<T, T> for Polygon<T> where
T: Float,
[src]
T: Float,
impl<T> SimplifyVW<T, T> for Polygon<T> where
T: Float,
[src]
T: Float,
fn simplifyvw(&self, epsilon: &T) -> Polygon<T>
[src]
impl<T> SimplifyVWPreserve<T, T> for Polygon<T> where
T: Float + RTreeNum,
[src]
T: Float + RTreeNum,
fn simplifyvw_preserve(&self, epsilon: &T) -> Polygon<T>
[src]
impl<T> StructuralEq for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> StructuralPartialEq for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T> TryFrom<Geometry<T>> for Polygon<T> where
T: Float,
[src]
T: Float,
type Error = FailedToConvertError
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>
[src]
geom: Geometry<T>
) -> Result<Polygon<T>, <Polygon<T> as TryFrom<Geometry<T>>>::Error>
impl<T: CoordinateType, NT: CoordinateType> TryMapCoords<T, NT> for Polygon<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Polygon<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Polygon<T> where
T: Send,
T: Send,
impl<T> Sync for Polygon<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Polygon<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Polygon<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, G> ExtremePoints<T> for G where
G: ConvexHull<T> + ExtremeIndices<T>,
T: Float + Signed,
[src]
G: ConvexHull<T> + ExtremeIndices<T>,
T: Float + Signed,
fn extreme_points(&Self) -> ExtremePoint<T>
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, G> RotatePoint<T> for G where
G: MapCoords<T, T, Output = G>,
T: Float,
[src]
G: MapCoords<T, T, Output = G>,
T: Float,
fn rotate_around_point(&Self, T, Point<T>) -> G
[src]
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, G> Translate<T> for G where
G: MapCoords<T, T, Output = G> + MapCoordsInplace<T>,
T: CoordinateType,
[src]
G: MapCoords<T, T, Output = G> + MapCoordsInplace<T>,
T: CoordinateType,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,