Polygon

Struct Polygon 

Source
pub struct Polygon<T>(pub Vec<T>);
Expand description

A closed curve composed of a chain of line segments.

The polygon is represented as a list of points, or vertices, with each pair of consecutive vertices, as well as the first and last vertex, sharing an edge.

Tuple Fields§

§0: Vec<T>

Implementations§

Source§

impl<T> Polygon<T>

Source

pub fn new(verts: impl IntoIterator<Item = T>) -> Self

Source

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

Returns an iterator over the edges of self.

Given a polygon ABC…XYZ, returns the edges AB, BC, …, XY, YZ, ZA. If self has zero or one vertices, returns an empty iterator.

§Examples
use retrofire_core::geom::{Polygon, Edge};
use retrofire_core::math::{Point2, pt2};

let pts: [Point2; _] = [pt2(0.0, 0.0), pt2(1.0, 1.0), pt2(2.0, 1.0)];

let poly = Polygon::new(pts);
let mut edges = poly.edges();

assert_eq!(edges.next(), Some(Edge(&pts[0], &pts[1])));
assert_eq!(edges.next(), Some(Edge(&pts[1], &pts[2])));
assert_eq!(edges.next(), Some(Edge(&pts[2], &pts[0])));
assert_eq!(edges.next(), None);

Trait Implementations§

Source§

impl<T: Clone> Clone for Polygon<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Polygon<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq> PartialEq for Polygon<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Eq> Eq for Polygon<T>

Source§

impl<T> StructuralPartialEq for Polygon<T>

Auto Trait Implementations§

§

impl<T> Freeze for Polygon<T>

§

impl<T> RefUnwindSafe for Polygon<T>
where T: RefUnwindSafe,

§

impl<T> Send for Polygon<T>
where T: Send,

§

impl<T> Sync for Polygon<T>
where T: Sync,

§

impl<T> Unpin for Polygon<T>
where T: Unpin,

§

impl<T> UnwindSafe for Polygon<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.