Struct iron_shapes::simple_polygon::SimplePolygon

pub struct SimplePolygon<T> {
    points: Vec<Point<T>>,
    normalized: bool,
}

A SimplePolygon is a polygon defined by vertices. It does not contain holes but can be self-intersecting.

TODO: Implement Deref for accessing the vertices.

Fields

points: Vec<Point<T>>

Vertices of the polygon.

normalized: bool

Set to true only if the vertices are normalized.

Implementations

impl<T> SimplePolygon<T>

pub fn new_raw(points: Vec<Point<T>>) -> Self

Create a new polygon from a list of points. The points are taken as they are, without reordering or simplification.

pub fn empty() -> Self

Create empty polygon without any vertices.

pub fn len(&self) -> usize

Get the number of vertices.

pub fn is_empty(&self) -> bool

Check if polygon has no vertices.

pub fn iter(&self) -> Iter<'_, Point<T>>

Shortcut for self.points.iter().

pub fn points(&self) -> &Vec<Point<T>>

Access the inner list of points.

impl<T: PartialOrd> SimplePolygon<T>

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

Create a new polygon from a list of points. The polygon is normalized by rotating the points.

pub fn with_points_mut<R>( &mut self, f: impl FnOnce(&mut Vec<Point<T>>) -> R ) -> R

Mutably access the inner list of points. If the polygon was normalized, then the modified list of points will be normalized again.

impl<T: PartialOrd> SimplePolygon<T>

pub fn normalize(&mut self)

Rotate the vertices to get the lexicographically smallest polygon. Does not change the orientation.

pub fn normalized(self) -> Self

Rotate the vertices to get the lexicographically smallest polygon. Does not change the orientation.

impl<T: PartialEq> SimplePolygon<T>

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

Check if polygons can be made equal by rotating their vertices.

impl<T: Copy> SimplePolygon<T>

pub fn from_rect(rect: &Rect<T>) -> Self

Create a new simple polygon from a rectangle.

impl<T> SimplePolygon<T>

fn prev(&self, i: usize) -> usize

Get index of previous vertex.

fn next(&self, i: usize) -> usize

Get index of next vertex.

impl<T: Copy> SimplePolygon<T>

fn iter_cycle(&self) -> impl Iterator<Item = &Point<T>>

Get an iterator over the polygon points. Point 0 is appended to the end to close the cycle.

pub fn edges(&self) -> Vec<Edge<T>>

Get all exterior edges of the polygon.

Examples

use iron_shapes::simple_polygon::SimplePolygon;
use iron_shapes::edge::Edge;
let coords = vec![(0, 0), (1, 0)];

let poly = SimplePolygon::from(coords);

assert_eq!(poly.edges(), vec![Edge::new((0, 0), (1, 0)), Edge::new((1, 0), (0, 0))]);

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

Iterate over all edges.

impl<T: CoordinateType> SimplePolygon<T>

pub fn normalize_orientation<Area>(&mut self)where Area: Num + PartialOrd + From<T>,

Normalize the points of the polygon such that they are arranged counter-clock-wise.

After normalizing, SimplePolygon::area_doubled_oriented() will return a semi-positive value.

For self-intersecting polygons, the orientation is not clearly defined. For example an 8 shape has not orientation. Here, the oriented area is used to define the orientation.

pub fn normalized_orientation<Area>(self) -> Selfwhere Area: Num + PartialOrd + From<T>,

Call normalize_orientation() while taking ownership and returning the result.

pub fn orientation<Area>(&self) -> Orientationwhere Area: Num + From<T> + PartialOrd,

Get the orientation of the polygon. The orientation is defined by the oriented area. A polygon with a positive area is oriented counter-clock-wise, otherwise it is oriented clock-wise.

Examples

use iron_shapes::simple_polygon::SimplePolygon;
use iron_shapes::point::Point;
use iron_shapes::types::Orientation;
let coords = vec![(0, 0), (3, 0), (3, 1)];

let poly = SimplePolygon::from(coords);

assert_eq!(poly.orientation::<i64>(), Orientation::CounterClockWise);

pub fn convex_hull(&self) -> SimplePolygon<T>where T: Ord,

Get the convex hull of the polygon.

Implements Andrew’s Monotone Chain algorithm. See: http://geomalgorithms.com/a10-_hull-1.html

pub fn is_rectilinear(&self) -> bool

Test if all edges are parallel to the x or y axis.

pub fn lower_left_vertex(&self) -> Point<T>

Get the vertex with lowest x-coordinate. Prefer lower y-coordinates to break ties.

Examples

use iron_shapes::simple_polygon::SimplePolygon;
use iron_shapes::point::Point;
let coords = vec![(0, 0), (1, 0), (-1, 2), (-1, 1)];

let poly = SimplePolygon::from(coords);

assert_eq!(poly.lower_left_vertex(), Point::new(-1, 1));

fn lower_left_vertex_with_index(&self) -> (usize, Point<T>)

Get the vertex with lowest x-coordinate and its index. Prefer lower y-coordinates to break ties.

Trait Implementations

impl<T: Clone> Clone for SimplePolygon<T>

fn clone(&self) -> SimplePolygon<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SimplePolygon<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for SimplePolygon<T>where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, T> DoubledOrientedArea<A> for SimplePolygon<T>where T: CoordinateType, A: Num + From<T>,

fn area_doubled_oriented(&self) -> A

Calculates the doubled oriented area.

Using doubled area allows to compute in the integers because the area of a polygon with integer coordinates is either integer or half-integer.

The area will be positive if the vertices are listed counter-clockwise, negative otherwise.

Complexity: O(n)

Examples

use iron_shapes::traits::DoubledOrientedArea;
use iron_shapes::simple_polygon::SimplePolygon;
let coords = vec![(0, 0), (3, 0), (3, 1)];

let poly = SimplePolygon::from(coords);

let area: i64 = poly.area_doubled_oriented();
assert_eq!(area, 3);

impl<T> From<&SimplePolygon<T>> for Polygon<T>where T: Copy,

Create a polygon from a simple polygon.

fn from(simple_polygon: &SimplePolygon<T>) -> Self

Converts to this type from the input type.

impl<I, T, P> From<I> for SimplePolygon<T>where T: Copy + PartialOrd, I: IntoIterator<Item = P>, Point<T>: From<P>,

Create a polygon from a type that is convertible into an iterator of values convertible to Points.

fn from(iter: I) -> Self

Converts to this type from the input type.

impl<T> From<SimplePolygon<T>> for Geometry<T>

fn from(x: SimplePolygon<T>) -> Geometry<T>

Converts to this type from the input type.

impl<T> From<SimplePolygon<T>> for Polygon<T>

Create a polygon from a simple polygon.

fn from(simple_polygon: SimplePolygon<T>) -> Self

Converts to this type from the input type.

impl<T, P> FromIterator<P> for SimplePolygon<T>where T: Copy, P: Into<Point<T>>,

Create a polygon from a iterator of values convertible to Points.

fn from_iter<I>(iter: I) -> Selfwhere I: IntoIterator<Item = P>,

Creates a value from an iterator.

impl<T: Hash> Hash for SimplePolygon<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> MapPointwise<T> for SimplePolygon<T>where T: CoordinateType,

fn transform<F: Fn(Point<T>) -> Point<T>>(&self, tf: F) -> Self

Point wise transformation.

impl<T: PartialEq> PartialEq<SimplePolygon<T>> for SimplePolygon<T>

fn eq(&self, other: &SimplePolygon<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for SimplePolygon<T>where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryBoundingBox<T> for SimplePolygon<T>where T: Copy + PartialOrd,

fn try_bounding_box(&self) -> Option<Rect<T>>

Return the bounding box of this geometry if a bounding box is defined.

impl<T: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for SimplePolygon<T>

type Output = SimplePolygon<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<Self::Output>

Try to cast to target data type.

fn cast(&self) -> Self::Output

Cast to target data type.

impl<T> WindingNumber<T> for SimplePolygon<T>where T: CoordinateType,

fn winding_number(&self, point: Point<T>) -> isize

Calculate the winding number of the polygon around this point.

TODO: Define how point on edges and vertices is handled.

See: http://geomalgorithms.com/a03-_inclusion.html

fn contains_point_non_oriented(&self, point: Point<T>) -> bool

Check if point is inside the polygon, i.e. the polygons winds around the point a non-zero number of times.

fn contains_point(&self, point: Point<T>) -> bool

Check if point is inside the polygon, i.e. the polygon winds around the point an odd number of times.

impl<T: Eq> Eq for SimplePolygon<T>

impl<T> StructuralEq for SimplePolygon<T>

impl<T> StructuralPartialEq for SimplePolygon<T>