Struct nannou::geom::polygon::Polygon

pub struct Polygon<I> {
    pub points: I,
}

A simple type wrapper around a list of points that describe a polygon.

Fields

points: I

The iterator yielding all points in the polygon.

Implementations

impl<I> Polygon<I>

where I: Iterator,

pub fn new<P>(points: P) -> Polygon<I>

where P: IntoIterator<IntoIter = I, Item = <I as Iterator>::Item>,

Construct a new polygon from the given list of points describing its vertices.

pub fn triangles(self) -> Option<Triangles<I>>

Triangulate the polygon given as a list of Points describing its sides.

Returns None if the polygon’s iterator yields less than two points.

pub fn contains( self, p: &<I as Iterator>::Item ) -> Option<Tri<<I as Iterator>::Item>>

where <I as Iterator>::Item: Vertex2d,

Returns Some with the touched triangle if the given Point is over the polygon described by the given series of points.

This uses the triangles function internally.

pub fn bounding_rect( self ) -> Option<Rect<<<I as Iterator>::Item as Vertex>::Scalar>>

where <I as Iterator>::Item: Vertex2d,

The Rect that bounds the polygon.

Returns None if the polygon’s point iterator is empty.

pub fn bounding_cuboid( self ) -> Option<Cuboid<<<I as Iterator>::Item as Vertex>::Scalar>>

where <I as Iterator>::Item: Vertex3d,

The `Cuboid that bounds the polygon.

Returns None if the polygon’s point iterator is empty.

Trait Implementations

impl<I> Clone for Polygon<I>

where I: Clone,

fn clone(&self) -> Polygon<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Polygon<I>

where I: Debug,

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

Formats the value using the given formatter.

impl<I> PartialEq for Polygon<I>

where I: PartialEq,

fn eq(&self, other: &Polygon<I>) -> 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<I> Eq for Polygon<I>

where I: Eq,

impl<I> StructuralEq for Polygon<I>

impl<I> StructuralPartialEq for Polygon<I>