Struct SPolygon

pub struct SPolygon {
    pub vertices: Vec<Point>,
    pub bbox: Rect,
    pub area: f32,
    pub diameter: f32,
    pub poi: Circle,
    pub surrogate: Option<SPSurrogate>,
}

A Simple Polygon is a polygon that does not intersect itself and contains no holes. It is a closed shape with a finite number of vertices and edges. read more

Fields

vertices: Vec<Point>

Set of points that form the polygon

bbox: Rect

Bounding box

area: f32

Area of its interior

diameter: f32

Maximum distance between any two points in the polygon

poi: Circle

Pole of inaccessibility represented as a circle

surrogate: Option<SPSurrogate>

Optional surrogate representation of the polygon (subset of the original)

Implementations

impl SPolygon

pub fn new(points: Vec<Point>) -> Result<Self>

Create a new simple polygon from a set of points, expensive operations are performed here! Use Self::clone() or Self::transform() to avoid recomputation.

pub fn generate_surrogate(&mut self, config: SPSurrogateConfig)

pub fn vertex(&self, i: usize) -> Point

pub fn edge(&self, i: usize) -> Edge

pub fn edge_iter(&self) -> impl Iterator<Item = Edge> + '_

pub fn n_vertices(&self) -> usize

pub fn surrogate(&self) -> &SPSurrogate

pub fn calculate_diameter(points: Vec<Point>) -> f32

pub fn generate_bounding_box(points: &[Point]) -> Rect

pub fn calculate_area(points: &[Point]) -> f32

pub fn calculate_poi(points: &[Point], diameter: f32) -> Circle

pub fn centroid(&self) -> Point

Trait Implementations

impl Clone for SPolygon

fn clone(&self) -> SPolygon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CollidesWith<Point> for SPolygon

fn collides_with(&self, point: &Point) -> bool

impl Debug for SPolygon

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

Formats the value using the given formatter.

impl DistanceTo<Point> for SPolygon

fn distance_to(&self, point: &Point) -> f32

Minimum distance between two primitives. Will be 0 in case of a collision.

fn sq_distance_to(&self, point: &Point) -> f32

Squared version of DistanceTo::distance_to

impl<T> From<T> for SPolygon

where T: Borrow<Rect>,

fn from(r: T) -> Self

Converts to this type from the input type.

impl SeparationDistance<Point> for SPolygon

fn separation_distance(&self, point: &Point) -> (GeoPosition, f32)

In case of a collision between self and other, returns GeoPosition::Interior and the minimum distance to separate the two primitives. Otherwise, returns GeoPosition::Exterior and the minimum distance between the two primitives. (similar to DistanceTo::distance_to)

fn sq_separation_distance(&self, point: &Point) -> (GeoPosition, f32)

Squared version of SeparationDistance::separation_distance

impl Transformable for SPolygon

fn transform(&mut self, t: &Transformation) -> &mut Self

Applies a transformation to self.

fn transform_clone(&self, t: &Transformation) -> Self

Applies a transformation to a clone.

impl TransformableFrom for SPolygon

fn transform_from(&mut self, reference: &Self, t: &Transformation) -> &mut Self

Applies a transformation on the reference object and stores the result in self.