[−][src]Struct geo_types::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.
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 Coordinate
of each ring has
the same value.
Validity
-
The exterior and interior rings must be valid
LinearRing
s (seeLineString
). -
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 thePolygon
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 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: FnOnce(&mut LineString<T>),
[src]
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::{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: FnOnce(&mut [LineString<T>]),
[src]
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 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,
pub fn is_convex(&self) -> bool
[src]
Please use geo::is_convex
on poly.exterior()
instead
Determine whether a Polygon is convex
Trait Implementations
impl<T: Clone> Clone for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: Debug> Debug for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: Eq> Eq for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
impl<T: CoordinateType> From<Polygon<T>> for Geometry<T>
[src]
impl<T: CoordinateType> From<Rect<T>> for Polygon<T>
[src]
impl<T: CoordinateType> From<Triangle<T>> for Polygon<T>
[src]
impl<T: Hash> Hash for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: PartialEq> PartialEq<Polygon<T>> for Polygon<T> where
T: CoordinateType,
[src]
T: CoordinateType,
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,
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,
pub fn borrow_mut(&mut self) -> &mut 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> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
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.
pub 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>,