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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
//! Standard library lofts.

use anyhow::Result;
use derive_docs::stdlib;
use kcmc::{each_cmd as mcmd, length_unit::LengthUnit, ModelingCmd};
use kittycad_modeling_cmds as kcmc;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{
    errors::{KclError, KclErrorDetails},
    executor::{ExecState, ExtrudeGroup, KclValue, SketchGroup},
    std::{extrude::do_post_extrude, fillet::default_tolerance, Args},
};

const DEFAULT_V_DEGREE: u32 = 2;

/// Data for a loft.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, ts_rs::TS, JsonSchema)]
#[ts(export)]
#[serde(rename_all = "camelCase")]
pub struct LoftData {
    /// Degree of the interpolation. Must be greater than zero.
    /// For example, use 2 for quadratic, or 3 for cubic interpolation in the V direction.
    /// This defaults to 2, if not specified.
    pub v_degree: Option<std::num::NonZeroU32>,
    /// Attempt to approximate rational curves (such as arcs) using a bezier.
    /// This will remove banding around interpolations between arcs and non-arcs.  It may produce errors in other scenarios
    /// Over time, this field won't be necessary.
    #[serde(default)]
    pub bez_approximate_rational: Option<bool>,
    /// This can be set to override the automatically determined topological base curve, which is usually the first section encountered.
    #[serde(default)]
    pub base_curve_index: Option<u32>,
    /// Tolerance for the loft operation.
    #[serde(default)]
    pub tolerance: Option<f64>,
}

impl Default for LoftData {
    fn default() -> Self {
        Self {
            // This unwrap is safe because the default value is always greater than zero.
            v_degree: Some(std::num::NonZeroU32::new(DEFAULT_V_DEGREE).unwrap()),
            bez_approximate_rational: None,
            base_curve_index: None,
            tolerance: None,
        }
    }
}

/// Create a 3D surface or solid by interpolating between two or more sketches.
pub async fn loft(_exec_state: &mut ExecState, args: Args) -> Result<KclValue, KclError> {
    let (sketch_groups, data): (Vec<SketchGroup>, Option<LoftData>) = args.get_sketch_groups_and_data()?;

    let extrude_group = inner_loft(sketch_groups, data, args).await?;
    Ok(KclValue::ExtrudeGroup(extrude_group))
}

/// Create a 3D surface or solid by interpolating between two or more sketches.
///
/// The sketches need to closed and on the same plane.
///
/// ```no_run
/// // Loft a square and a triangle.
/// const squareSketch = startSketchOn('XY')
///     |> startProfileAt([-100, 200], %)
///     |> line([200, 0], %)
///     |> line([0, -200], %)
///     |> line([-200, 0], %)
///     |> lineTo([profileStartX(%), profileStartY(%)], %)
///     |> close(%)
///
/// const triangleSketch = startSketchOn(offsetPlane('XY', 75))
///     |> startProfileAt([0, 125], %)
///     |> line([-15, -30], %)
///     |> line([30, 0], %)
///     |> lineTo([profileStartX(%), profileStartY(%)], %)
///     |> close(%)
///
/// loft([squareSketch, triangleSketch])
/// ```
///
/// ```no_run
/// // Loft a square, a circle, and another circle.
/// const squareSketch = startSketchOn('XY')
///     |> startProfileAt([-100, 200], %)
///     |> line([200, 0], %)
///     |> line([0, -200], %)
///     |> line([-200, 0], %)
///     |> lineTo([profileStartX(%), profileStartY(%)], %)
///     |> close(%)
///
/// const circleSketch0 = startSketchOn(offsetPlane('XY', 75))
///     |> circle([0, 100], 50, %)
///
/// const circleSketch1 = startSketchOn(offsetPlane('XY', 150))
///     |> circle([0, 100], 20, %)
///
/// loft([squareSketch, circleSketch0, circleSketch1])
/// ```
///
/// ```no_run
/// // Loft a square, a circle, and another circle with options.
/// const squareSketch = startSketchOn('XY')
///     |> startProfileAt([-100, 200], %)
///     |> line([200, 0], %)
///     |> line([0, -200], %)
///     |> line([-200, 0], %)
///     |> lineTo([profileStartX(%), profileStartY(%)], %)
///     |> close(%)
///
/// const circleSketch0 = startSketchOn(offsetPlane('XY', 75))
///     |> circle([0, 100], 50, %)
///
/// const circleSketch1 = startSketchOn(offsetPlane('XY', 150))
///     |> circle([0, 100], 20, %)
///
/// loft([squareSketch, circleSketch0, circleSketch1], {
///     // This can be set to override the automatically determined
///     // topological base curve, which is usually the first section encountered.
///     baseCurveIndex: 0,
///     // Attempt to approximate rational curves (such as arcs) using a bezier.
///     // This will remove banding around interpolations between arcs and non-arcs.
///     // It may produce errors in other scenarios Over time, this field won't be necessary.
///     bezApproximateRational: false,
///     // Tolerance for the loft operation.
///     tolerance: 0.000001,
///     // Degree of the interpolation. Must be greater than zero.
///     // For example, use 2 for quadratic, or 3 for cubic interpolation in
///     // the V direction. This defaults to 2, if not specified.
///     vDegree: 2,
/// })
/// ```
#[stdlib {
    name = "loft",
}]
async fn inner_loft(
    sketch_groups: Vec<SketchGroup>,
    data: Option<LoftData>,
    args: Args,
) -> Result<Box<ExtrudeGroup>, KclError> {
    // Make sure we have at least two sketches.
    if sketch_groups.len() < 2 {
        return Err(KclError::Semantic(KclErrorDetails {
            message: format!(
                "Loft requires at least two sketches, but only {} were provided.",
                sketch_groups.len()
            ),
            source_ranges: vec![args.source_range],
        }));
    }

    // Get the loft data.
    let data = data.unwrap_or_default();

    let id = uuid::Uuid::new_v4();
    args.batch_modeling_cmd(
        id,
        ModelingCmd::from(mcmd::Loft {
            section_ids: sketch_groups.iter().map(|group| group.id).collect(),
            base_curve_index: data.base_curve_index,
            bez_approximate_rational: data.bez_approximate_rational.unwrap_or(false),
            tolerance: LengthUnit(data.tolerance.unwrap_or(default_tolerance(&args.ctx.settings.units))),
            v_degree: data
                .v_degree
                .unwrap_or_else(|| std::num::NonZeroU32::new(DEFAULT_V_DEGREE).unwrap()),
        }),
    )
    .await?;

    // Using the first sketch as the base curve, idk we might want to change this later.
    do_post_extrude(sketch_groups[0].clone(), 0.0, args).await
}