vsvg 0.5.0

Core library for pen-plotter graphics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use crate::{IntoBezPathTolerance, Point};
use kurbo::{BezPath, CubicBez};

/// A Catmull-Rom spline.
///
/// This is a curve that passes through all the points in the list, but is smooth. It is converted
/// to a series of cubic Bézier curves.
///
/// A minimum of 3 control points are needed to create a curve. If less than 3 points are provided,
/// an empty path is returned.
///
/// Strictly speaking, a Catmull-Rom spline starts at the second point and ends at the second to
/// last. This implementation duplicates the first and last points instead, so that all points are
/// traversed by the curve.
///
/// The Catmull-Rom spline is parameterized by a `tension` parameter. A tension of 1.0 is the
/// default. Higher values will make the curve more "tight" (closer to a polyline), while lower
/// values will make it more "loose". Values bellow ~0.2 yield very loose curves that can extend far
/// away from the control points. Negative values makes the curve pass backwards through control
/// points.
#[derive(Debug, Clone)]
pub struct CatmullRom {
    points: Vec<Point>,
    tension: f64,
}

impl Default for CatmullRom {
    fn default() -> Self {
        Self {
            tension: 1.0,
            points: Vec::new(),
        }
    }
}

impl CatmullRom {
    /// Create a new Catmull-Rom spline from a list of points.
    ///
    /// The `tension` parameter is set to 1.0.
    pub fn from_points(points: impl IntoIterator<Item = impl Into<Point>>) -> Self {
        Self {
            tension: 1.0,
            points: points.into_iter().map(Into::into).collect(),
        }
    }

    /// Set the tension parameter.
    #[must_use]
    pub fn tension(mut self, tension: f64) -> Self {
        self.tension = tension;
        self
    }

    /// Get the control points.
    #[must_use]
    pub fn points(&self) -> &[Point] {
        &self.points
    }

    /// Add a control point.
    pub fn push_point(&mut self, point: impl Into<Point>) {
        self.points.push(point.into());
    }
}

fn cubic_bez_from_catmull_rom_points(
    p0: Point,
    p1: Point,
    p2: Point,
    p3: Point,
    tension: f64,
) -> CubicBez {
    CubicBez::new(
        p1,
        p1 + (p2 - p0) / 6.0 / tension,
        p2 - (p3 - p1) / 6.0 / tension,
        p2,
    )
}

impl IntoBezPathTolerance for CatmullRom {
    fn into_bezpath_with_tolerance(self, _tolerance: f64) -> BezPath {
        let tension = self.tension;

        if self.points.len() < 3 {
            return BezPath::new();
        }

        BezPath::from_path_segments(
            [cubic_bez_from_catmull_rom_points(
                self.points[0],
                self.points[0],
                self.points[1],
                self.points[2],
                tension,
            )]
            .into_iter()
            .chain(
                self.points
                    .windows(4)
                    .map(|w| cubic_bez_from_catmull_rom_points(w[0], w[1], w[2], w[3], tension)),
            )
            .chain([cubic_bez_from_catmull_rom_points(
                self.points[self.points.len() - 3],
                self.points[self.points.len() - 2],
                self.points[self.points.len() - 1],
                self.points[self.points.len() - 1],
                tension,
            )])
            .map(kurbo::PathSeg::Cubic),
        )
    }
}