Struct Polygon

pub struct Polygon {
    pub outer: Ring,
    pub holes: Vec<Ring>,
}

Fields

outer: Ring

holes: Vec<Ring>

Implementations

impl Polygon

pub fn outline(&self) -> Polygon2

The outer boundary as a Polygon2, discarding any holes.

Named outline rather than offered as a From impl because the conversion is lossy and the loss is silent: an annulus and a filled disc have the same outline, so a caller that reaches for this to compute area gets the wrong answer with no error. Polygon2 models a simple polygon and cannot represent a hole, which is exactly why this has to be an explicit request rather than an implicit coercion.

Use polygon_area when the holes matter.

pub fn has_holes(&self) -> bool

Whether the polygon has inner boundaries that outline would drop.

Trait Implementations

impl Clone for Polygon

fn clone(&self) -> Polygon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Polygon

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

Formats the value using the given formatter.

impl PartialEq for Polygon

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Polygon