Struct visioncortex::Spline

pub struct Spline {
    pub points: Vec<PointF64>,
}

Series of connecting 2D Bezier Curves

Fields

points: Vec<PointF64>

1+3*(num_curves) points, where the first curve is represented by the first 4 points and each subsequent curve is represented by the last point in the previous curve plus 3 points Points are of PointF64 type.

Implementations

impl Spline

pub fn new(point: PointF64) -> Self

Creates an empty spline defined by a starting point

pub fn add(&mut self, point2: PointF64, point3: PointF64, point4: PointF64)

Adds a curve to the end of the spline. Takes 3 points that are the second to fourth control points of the bezier curve. Note that the first control point is taken from the last point of the previous curve.

pub fn iter(&self) -> Iter<'_, PointF64>

Returns an iterator on the vector of points on the spline

pub fn len(&self) -> usize

Returns the number of points on the spline

pub fn num_curves(&self) -> usize

Returns the number of curves on the spline

pub fn is_empty(&self) -> bool

Returns true if the spline contains no curve, false otherwise A curve is defined by 4 points, so a non-empty spline should contain at least 4 points.

pub fn offset(&mut self, offset: &PointF64)

Applies an offset to all points on the spline

pub fn from_image(
    image: &BinaryImage,
    clockwise: bool,
    corner_threshold: f64,
    outset_ratio: f64,
    segment_length: f64,
    max_iterations: usize,
    splice_threshold: f64
) -> Self

Returns a spline created from image. The following steps are performed:

1. Convert pixels into path
2. Simplify the path into polygon
3. Smoothen the polygon and approximate it with a curve-fitter

Corner/Splice thresholds are specified in radians. Length threshold is specified in pixels (length unit in path coordinate system).

pub fn from_path_f64(path: &PathF64, splice_threshold: f64) -> Self

Returns a spline by curve-fitting a path.

Splice threshold is specified in radians.

pub fn to_svg_string(&self, close: bool, offset: &PointF64) -> String

Converts spline to svg path. Panic if the length of spline is not valid (not 1+3n for some integer n)

Trait Implementations

impl Debug for Spline

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

Formats the value using the given formatter.

impl Default for Spline

fn default() -> Spline

Returns the “default value” for a type.