Skip to main content

Polygon

Struct Polygon 

Source
pub struct Polygon { /* private fields */ }
Expand description

A set of vertices with a topology type and orientation query.

Mirrors the C++ Polygon<Vector> template. The base Polygon::is_valid requires at least one vertex; crate::Wgs84Polygon wraps this and overrides validity to require at least three.

Implementations§

Source§

impl Polygon

Source

pub fn new(polygon_type: PolygonType) -> Self

Construct an empty polygon of the given type.

Source

pub fn with_vertices(polygon_type: PolygonType, vertices: Vec<Wgs84>) -> Self

Construct a polygon of the given type with the supplied vertices.

Source

pub fn add_vertex(&mut self, position: Wgs84)

Append a single vertex.

Source

pub fn add_vertices(&mut self, vertices: &[Wgs84])

Append a list of vertices, in order.

Source

pub fn get(&self, index: usize) -> Wgs84

Get a vertex by index (panics on out-of-bounds, like C++ operator[]).

Source

pub fn set(&mut self, index: usize, value: Wgs84)

Set a vertex by index.

Source

pub fn len(&self) -> usize

Number of vertices.

Source

pub fn is_empty(&self) -> bool

Whether the polygon has no vertices.

Source

pub fn polygon_type(&self) -> PolygonType

Get the polygon type.

Source

pub fn set_type(&mut self, polygon_type: PolygonType)

Set the polygon type.

Source

pub fn is_valid(&self) -> bool

Whether this is a valid polygon.

Base implementation: at least one vertex. crate::Wgs84Polygon requires at least three.

Source

pub fn vertices(&self) -> &[Wgs84]

Get the (shared) slice of vertices.

Source

pub fn vertices_mut(&mut self) -> &mut Vec<Wgs84>

Get the mutable Vec of vertices.

Source

pub fn orientation(&self) -> Orientation

Compute the winding order via the signed shoelace formula.

Only works for SimplePolygon and a single-triangle TriangleList (exactly 3 vertices). All other types return InvalidOrientation without computing area. Collinear vertices (zero area) also return InvalidOrientation.

Uses raw (lon, lat) doubles; no normalization.

Trait Implementations§

Source§

impl Clone for Polygon

Source§

fn clone(&self) -> Polygon

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Polygon

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Polygon

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Polygon

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.