Struct ConvexPlanRegion 

pub struct ConvexPlanRegion { /* private fields */ }

A convex plan polygon, anticlockwise, in canonical metres.

Implementations

impl ConvexPlanRegion

pub fn try_new(ring: PlanRing) -> Result<Self, ProximityError>

A region from its vertices, in order and without repeating the first. They must be finite, at least three, turn anticlockwise at every vertex (collinear vertices are accepted) and enclose a positive area.

pub fn ring(&self) -> &[[f64; 2]]

The vertices, anticlockwise.

pub fn bounds(&self) -> ([f64; 2], [f64; 2])

The least and greatest corner of the region’s plan box.

pub fn area_square_metres(&self) -> f64

The region’s area in square metres.

pub fn separation(&self, other: &Self) -> f64

Signed separation from other: the plan distance between the two regions when they are apart, zero when they touch, and minus the least depth one reaches into the other along an edge normal when they overlap with positive area.

Both are convex, so they are apart exactly when an edge normal of one separates them, and their distance is then the least distance from a vertex of one to an edge of the other.

Trait Implementations

impl Clone for ConvexPlanRegion

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvexPlanRegion

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

Formats the value using the given formatter.

impl PartialEq for ConvexPlanRegion

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConvexPlanRegion