Struct Polygon

pub struct Polygon<'l, T> {
    pub points: &'l [T],
    pub closed: bool,
}

Available on crate feature canvas only.

A view over a sequence of endpoints forming a polygon.

Example

use lyon_path::polygon::Polygon;
use lyon_path::geom::point;

let path = Polygon {
    points: &[
        point(0.0, 0.0),
        point(10.0, 10.0),
        point(0.0, 10.0),
    ],
    closed: true,
};

for event in path.path_events() {
    // same as iterating a regular `Path` object.
}

Fields

points: &'l [T]

closed: bool

Implementations

impl<'l, T> Polygon<'l, T>

pub fn iter(&self) -> PolygonIter<'l, T>

Returns an iterator of Event<&T>.

pub fn id_iter(&self) -> PolygonIdIter

Returns an iterator of IdEvent.

pub fn path_events(&self) -> PathEvents<'_, T>

where T: Position,

Returns an iterator of PathEvent.

pub fn event(&self, id: EventId) -> Event<&T, ()>

Returns the event for a given event ID.

Trait Implementations

impl<'l, T> Clone for Polygon<'l, T>

where T: Clone,

fn clone(&self) -> Polygon<'l, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'l, T> Index<EndpointId> for Polygon<'l, T>

type Output = T

The returned type after indexing.

fn index(&self, id: EndpointId) -> &T

Performs the indexing (container[index]) operation.

impl<'l, Endpoint> PositionStore for Polygon<'l, Endpoint>

where Endpoint: Position,

fn get_endpoint(&self, id: EndpointId) -> Point2D<f32, UnknownUnit>

fn get_control_point(&self, _: ControlPointId) -> Point2D<f32, UnknownUnit>