Struct geom::polygon::Polygon

source · [−]

pub struct Polygon {
    pub(crate) points: Vec<Pt2D>,
    pub(crate) indices: Vec<u16>,
    rings: Option<Vec<Ring>>,
}

Fields

points: Vec<Pt2D>indices: Vec<u16>

Groups of three indices make up the triangles

rings: Option<Vec<Ring>>

If the polygon has holes, explicitly store all the rings (the one outer and all of the inner) so they can later be used to generate outlines and such. If the polygon has no holes, then this will just be None, since the points form a ring.

Implementations

source

pub fn triangles(&self) -> Vec<Triangle>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

pub fn contains_pt(&self, pt: Pt2D) -> bool

Does this polygon contain the point in its interior?

source

pub fn get_bounds(&self) -> Bounds

source

fn transform<F: Fn(&Pt2D) -> Pt2D>(&self, f: F) -> Result<Self>

Transformations must preserve Rings.

source

pub fn translate(&self, dx: f64, dy: f64) -> Self

source

pub fn scale(&self, factor: f64) -> Result<Self>

When factor is small, this may collapse Rings and thus fail.

source

pub fn must_scale(&self, factor: f64) -> Self

When factor is known to be over 1, then scaling can’t fail.

source

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

source

pub fn rotate_around(&self, angle: Angle, pivot: Pt2D) -> Self

source

pub fn centered_on(&self, center: Pt2D) -> Self

source

pub fn points(&self) -> &Vec<Pt2D>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

The order of these points depends on the constructor! The first and last point may or may not match. Polygons constructed from PolyLines will have a very weird order.

source

pub fn into_points(self) -> Vec<Pt2D>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

source

pub fn into_ring(self) -> Ring

source

pub fn get_outer_ring(&self) -> Option<Ring>

Get the outer ring of this polygon. This should usually succeed.

source

pub fn center(&self) -> Pt2D

source

pub fn maybe_rectangle(width: f64, height: f64) -> Result<Self>

Top-left at the origin. Doesn’t take Distance, because this is usually pixels, actually.

source

pub fn rectangle(width: f64, height: f64) -> Self

Top-left at the origin. Doesn’t take Distance, because this is usually pixels, actually. Note this will panic if width or height is 0.

source

pub fn rectangle_centered(
    center: Pt2D,
    width: Distance,
    height: Distance
) -> Self

source

pub fn rectangle_two_corners(pt1: Pt2D, pt2: Pt2D) -> Option<Self>

source

pub fn maybe_rounded_rectangle<R: Into<CornerRadii>>(
 w: f64,
 h: f64,
 r: R
) -> Option<Self>

Top-left at the origin. Doesn’t take Distance, because this is usually pixels, actually.

source

pub fn pill(w: f64, h: f64) -> Self

A rectangle, two sides of which are fully rounded half-circles.

source

pub fn rounded_rectangle<R: Into<CornerRadii>>(w: f64, h: f64, r: R) -> Self

Top-left at the origin. Doesn’t take Distance, because this is usually pixels, actually. If it’s not possible to apply the specified radius, fallback to a regular rectangle.

source

pub fn union_all_into_multipolygon(list: Vec<Self>) -> MultiPolygon

Union all of the polygons into one geo::MultiPolygon

source

pub fn intersection(&self, other: &Self) -> Result<Vec<Self>>

source

pub fn difference(&self, other: &Self) -> Result<Vec<Self>>

source

pub fn convex_hull(list: Vec<Self>) -> Result<Self>

source

pub fn concave_hull(points: Vec<Pt2D>, concavity: u32) -> Result<Self>

source

pub fn polylabel(&self) -> Pt2D

Find the “pole of inaccessibility” – the most distant internal point from the polygon outline

source

pub fn intersects(&self, other: &Self) -> bool

Do two polygons intersect at all?

source

pub fn intersects_polyline(&self, pl: &PolyLine) -> bool

Does this polygon intersect a polyline?

source

pub fn to_outline(&self, thickness: Distance) -> Result<Tessellation>

Creates the outline around the polygon (both the exterior and holes), with the thickness half straddling the polygon and half of it just outside. Only works for polygons that’re formed from rings.

Returns a Tessellation that may union together the outline from the exterior and multiple holes. Callers that need a Polygon must call to_outline on the individual Rings.

source

pub fn area(&self) -> f64

Usually m^2, unless the polygon is in screen-space

source

pub fn clip_polyline(&self, input: &PolyLine) -> Option<Vec<Pt2D>>

Doesn’t handle multiple crossings in and out.

source

pub fn clip_ring(&self, input: &Ring) -> Option<Vec<Pt2D>>

source

pub fn to_geojson(&self, gps: Option<&GPSBounds>) -> Geometry

If the polygon is just a single outer ring, produces a GeoJSON polygon. Otherwise, produces a GeoJSON multipolygon consisting of individual triangles. Optionally map the world-space points back to GPS.

source

pub fn from_geojson_bytes(
 raw_bytes: &[u8],
 gps_bounds: &GPSBounds,
 require_in_bounds: bool
) -> Result<Vec<(Self, Tags)>>

Extracts all polygons from raw bytes representing a GeoJSON file, along with the string key/value properties. Only the first polygon from multipolygons is returned. If require_in_bounds is set, then the polygon must completely fit within the gps_bounds.

source