Struct Segments 

pub struct Segments { /* private fields */ }

An arena of segments, each of which is a cubic Bézier.

Segments are indexed by SegIdx and can be retrieved by indexing (i.e. with square brackets).

Implementations

impl Segments

pub fn len(&self) -> usize

The number of segments in this arena.

pub fn indices(&self) -> impl Iterator<Item = SegIdx>

Iterate over all indices that can be used to index into this arena.

pub fn segments(&self) -> impl Iterator<Item = &Segment>

Iterate over all segments in this arena.

pub fn oriented_start(&self, idx: SegIdx) -> Point

Returns the starting point of the segment at idx, relative to the segment’s original orientation.

The segment itself is stored in sweep-line order (i.e. its starting point has the smaller y coordinate) regardless of the original orientation of the segment. Use this method to retrieve the segment’s original start point.

pub fn oriented_end(&self, idx: SegIdx) -> Point

Returns the ending point of the segment at idx, relative to the segment’s original orientation.

The segment itself is stored in sweep-line order (i.e. its starting point has the smaller y coordinate) regardless of the original orientation of the segment. Use this method to retrieve the segment’s original end point.

pub fn contour_next(&self, idx: SegIdx) -> Option<SegIdx>

Returns the index of the segment following idx.

If idx is part of a non-closed path and it is the last segment, this returns None. If idx is part of a closed path, this will always return Some, and you might need to be careful to avoid looping infinitely.

pub fn contour_prev(&self, idx: SegIdx) -> Option<SegIdx>

Returns the index of the segment preceding idx.

If idx is part of a non-closed path and it is the first segment, this returns None. If idx is part of a closed path, this will always return Some, and you might need to be careful to avoid looping infinitely.

pub fn positively_oriented(&self, idx: SegIdx) -> bool

Does the sweep-line orientation of idx agree with its original orientation?

pub fn add_points<P: Into<Point>>(&mut self, ps: impl IntoIterator<Item = P>)

Add a (non-closed) polyline to this arena.

pub fn add_closed_polylines<P: Into<Point>>( &mut self, ps: impl IntoIterator<Item = impl IntoIterator<Item = P>>, )

Add a collection of closed polylines to this arena.

This can be much faster than calling add_cycles repeatedly.

pub fn add_closed_polyline<P: Into<Point>>( &mut self, ps: impl IntoIterator<Item = P>, )

Add a closed polyline to this arena.

pub fn add_bez_path(&mut self, p: &BezPath) -> Result<(), NonClosedPath>

Add a Bézier path to this arena.

The path can contain multiple subpaths, and each of them must be closed.

pub fn add_non_closed_bez_path( &mut self, p: &BezPath, ) -> Result<(), NonClosedPath>

Add a Bézier path to this arena.

The path can contain multiple subpaths, and each of them may or may not be closed.

pub fn from_closed_polyline<P: Into<Point>>( ps: impl IntoIterator<Item = P>, ) -> Self

Construct a segment arena from a single closed polyline.

pub fn entrances(&self) -> &[(f64, SegIdx)]

All the entrance heights of segments, ordered by height.

Includes horizontal segments.

pub fn exits(&self) -> &[(f64, SegIdx)]

All the exit heights of segments, ordered by height.

Does not include horizontal segments.

pub fn check_invariants(&self)

Checks that we satisfy our internal invariants. For testing only.

Trait Implementations

impl Clone for Segments

fn clone(&self) -> Segments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Segments

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

Formats the value using the given formatter.

impl Default for Segments

fn default() -> Segments

Returns the “default value” for a type.

impl Index<SegIdx> for Segments

type Output = Segment

The returned type after indexing.

fn index(&self, index: SegIdx) -> &Self::Output

Performs the indexing (container[index]) operation.