Struct SimplePolygon

pub struct SimplePolygon {
    pub points: Vec<Point>,
    pub bbox: AARectangle,
    pub area: fsize,
    pub diameter: fsize,
    pub poi: Circle,
    pub surrogate: Option<SPSurrogate>,
}

Geometric primitive representing a simple polygon: https://en.wikipedia.org/wiki/Simple_polygon

Fields

points: Vec<Point>

Set of bounds describing the polygon

bbox: AARectangle

Bounding box

area: fsize

diameter: fsize

Maximum distance between any two points in the polygon

poi: Circle

Pole of inaccessibility

surrogate: Option<SPSurrogate>

Surrogate representation (subset of the simple polygon)

Implementations

impl SimplePolygon

pub fn new(points: Vec<Point>) -> 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 get_point(&self, i: usize) -> Point

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

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

pub fn number_of_points(&self) -> usize

pub fn surrogate(&self) -> &SPSurrogate

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

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

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

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

pub fn center_around_centroid(self) -> (SimplePolygon, Transformation)

Trait Implementations

impl Clone for SimplePolygon

fn clone(&self) -> SimplePolygon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CollidesWith<Point> for SimplePolygon

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

impl Debug for SimplePolygon

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

Formats the value using the given formatter.

impl Distance<Point> for SimplePolygon

fn sq_distance(&self, point: &Point) -> fsize

Squared version of Distance::distance

fn distance(&self, point: &Point) -> fsize

Minimum distance between two primitives. 0.0 if the primitives collide

impl<T> From<T> for SimplePolygon

where T: Borrow<AARectangle>,

fn from(r: T) -> Self

Converts to this type from the input type.

impl SeparationDistance<Point> for SimplePolygon

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

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 Distance::distance)

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

Squared version of SeparationDistance::separation_distance

impl Shape for SimplePolygon

fn centroid(&self) -> Point

Geometric center of the shape

fn area(&self) -> fsize

Area of the interior of the shape

fn bbox(&self) -> AARectangle

Bounding box of the shape

fn diameter(&self) -> fsize

The distance between the two furthest points in the shape.

impl Transformable for SimplePolygon

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

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

impl TransformableFrom for SimplePolygon

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