Struct geom::Ring

pub struct Ring {
    pts: Vec<Pt2D>,
}

Maybe a misnomer, but like a PolyLine, but closed.

Fields

pts: Vec<Pt2D>

Implementations

impl Ring

pub fn new(pts: Vec<Pt2D>) -> Result<Ring>

pub fn must_new(pts: Vec<Pt2D>) -> Ring

pub fn deduping_new(pts: Vec<Pt2D>) -> Result<Self>

First dedupes adjacent points

pub fn to_outline(&self, thickness: Distance) -> Polygon

Draws the ring with some thickness, with half of it straddling the interor of the ring, and half on the outside.

pub fn into_polygon(self) -> Polygon

pub fn points(&self) -> &Vec<Pt2D>

pub fn into_points(self) -> Vec<Pt2D>

pub fn all_intersections(&self, other: &PolyLine) -> Vec<Pt2D>

Be careful with the order of results. Hits on an earlier line segment of other show up first, but if the ring hits a line segment at multiple points, who knows. Dedupes.

pub(crate) fn get_both_slices_btwn(
    &self,
    pt1: Pt2D,
    pt2: Pt2D
) -> Option<(PolyLine, PolyLine)>

pub fn get_slice_between(
    &self,
    pt1: Pt2D,
    pt2: Pt2D,
    longer: bool
) -> Option<PolyLine>

Assuming both points are somewhere along the ring, return the points in between the two, by tracing along the ring in the longer or shorter direction (depending on longer). If both points are the same, returns None. The result is oriented from pt1 to pt2.

pub fn get_shorter_slice_between(
    &self,
    pt1: Pt2D,
    pt2: Pt2D
) -> Option<PolyLine>

Assuming both points are somewhere along the ring, return the points in between the two, by tracing along the ring in the shorter direction. If both points are the same, returns None. The result is oriented from pt1 to pt2.

pub fn get_shorter_slice_btwn(&self, pt1: Pt2D, pt2: Pt2D) -> Option<PolyLine>

pub fn split_points(pts: &[Pt2D]) -> Result<(Vec<PolyLine>, Vec<Ring>)>

Extract all PolyLines and Rings. Doesn’t handle crazy double loops and stuff.

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

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

Produces a GeoJSON polygon, optionally mapping the world-space points back to GPS.

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

Translates the ring by a fixed offset.

pub fn polylabel(&self) -> Pt2D

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

pub fn doubles_back(&self) -> bool

Look for “bad” rings that double back on themselves. These’re likely to cause many downstream problems. “Bad” means the order of points doesn’t match the order when sorting by angle from the center.

TODO I spot many false positives. Look for better definitions – maybe self-intersecting polygons?

pub fn as_geo_linestring(&self) -> String

Print the coordinates of this ring as a geo::LineString for easy bug reports

Trait Implementations

impl Clone for Ring

fn clone(&self) -> Ring

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ring

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ring

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Ring

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

Formats the value using the given formatter.

impl From<LineString<f64>> for Ring

fn from(line_string: LineString) -> Self

Converts to this type from the input type.

impl From<Ring> for LineString

fn from(ring: Ring) -> Self

Converts to this type from the input type.

impl PartialEq<Ring> for Ring

fn eq(&self, other: &Ring) -> bool

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

fn ne(&self, other: &Ring) -> bool

This method tests for !=.

impl Serialize for Ring

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Ring