Struct kurbo::BezPath

pub struct BezPath(_);

A path that can Bézier segments up to cubic, possibly with multiple subpaths.

Implementations

impl BezPath

pub fn new() -> BezPath

Create a new path.

pub fn from_vec(v: Vec<PathEl>) -> BezPath

Create a path from a vector of path elements.

pub fn push(&mut self, el: PathEl)

Push a generic path element onto the path.

pub fn moveto<V: Into<Vec2>>(&mut self, p: V)

Push a moveto element onto the path.

pub fn lineto<V: Into<Vec2>>(&mut self, p: V)

Push a lineto element onto the path.

pub fn quadto<V: Into<Vec2>>(&mut self, p1: V, p2: V)

Push a quadto element onto the path.

pub fn curveto<V: Into<Vec2>>(&mut self, p1: V, p2: V, p3: V)

Push a curveto element onto the path.

pub fn closepath(&mut self)

Push a closepath element onto the path.

pub fn elements(&self) -> &[PathEl]

Get the path elements.

pub fn segments<'a>(&'a self) -> impl Iterator<Item = (usize, PathSeg)> + 'a

Iterate over the path segments.

The iterator returns the index within the path and the segment.

pub fn get_seg(&self, ix: usize) -> Option<PathSeg>

Get the segment at the given index.

pub fn is_empty(&self) -> bool

Returns true if the path contains no segments.

pub fn apply_affine(&mut self, affine: Affine)

Apply an affine transform to the path.

pub fn arclen(&self, accuracy: f64) -> f64

Compute the total arclength.

Here, accuracy specifies the accuracy for each Bézier segment. At worst, the total error is accuracy times the number of Bézier segments.

Note: this is one of the methods that could be implemented on an iterator of PathEl, to save allocation.

pub fn area(&self) -> f64

Compute the total signed area.

pub fn nearest(&self, p: Vec2, accuracy: f64) -> (usize, f64, f64)

Find the nearest point.

Panics if path is empty or invalid.

Returns the index of the element, the parameter within that segment, and the square of the distance to the point.

pub fn winding(&self, p: Vec2) -> i32

Compute the winding number.

TODO: make sure all the signs are consistent.

impl BezPath

pub fn to_svg(&self) -> String

Convert the path to an SVG path string representation.

The current implementation doesn’t take any special care to produce a short string (reducing precision, using relative movement).

pub fn from_svg(data: &str) -> Result<BezPath, SvgParseError>

Trait Implementations

impl Clone for BezPath

fn clone(&self) -> BezPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BezPath

fn default() -> BezPath

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a BezPath

type Item = PathEl

The type of the elements being iterated over.

type IntoIter = Cloned<Iter<'a, PathEl>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul<BezPath> for Affine

type Output = BezPath

The resulting type after applying the * operator.

fn mul(self, other: BezPath) -> BezPath

Performs the * operation.

impl Shape for BezPath

fn area(&self) -> f64

Signed area.

TODO: figure out sign convention, see #4.

TODO: clean up duplication with impl method.

fn winding(&self, pt: Vec2) -> i32

Winding number of point.

TODO: figure out sign convention, see #4.

TODO: clean up duplication with impl method.

type BezPathIter = IntoIter<PathEl, Global>

The iterator resulting from to_bez_path.

fn to_bez_path(&self, _tolerance: f64) -> Self::BezPathIter

Convert to a Bézier path, as an iterator over path elements.

fn perimeter(&self, accuracy: f64) -> f64

Total length of perimeter.

fn bounding_box(&self) -> Rect

The smallest rectangle that encloses the shape.

fn as_path_slice(&self) -> Option<&[PathEl]>

If the shape is stored as a slice of path elements, make that available.

fn as_line(&self) -> Option<Line>

If the shape is a line, make it available.

fn as_rect(&self) -> Option<Rect>

If the shape is a rectangle, make it available.