Fix helix sweep, you can make springs! (#5089)

* fix dumb mistake

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates for springs!

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update known issues

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>

docs/kcl/KNOWN-ISSUES.md

@@ -24,5 +24,3 @@ once fixed in engine will just start working here with no language changes.
     chamfer cases work currently.
 
 - **Appearance**: Changing the appearance on a loft does not work.
-
-- **Helix**: Currently sweeping a helix does not work.

docs/kcl/std.json

@@ -76961,9 +76961,9 @@
     "unpublished": false,
     "deprecated": false,
     "examples": [
-      "// Create a helix around the Z axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 16,\n  length = 10,\n  radius = 5,\n  axis = 'Z'\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('YZ')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n// |> sweep({ path = helixPath }, %)",
-      "// Create a helix around an edge.\nhelper001 = startSketchOn('XZ')\n  |> startProfileAt([0, 0], %)\n  |> line([0, 10], %, $edge001)\n\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 16,\n  length = 10,\n  radius = 5,\n  axis = edge001\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n// |> sweep({ path = helixPath }, %)",
-      "// Create a helix around a custom axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 16,\n  length = 10,\n  radius = 5,\n  axis = {\n    custom = {\n      axis = [0, 0, 1.0],\n      origin = [0, 0.25, 0]\n    }\n  }\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n// |> sweep({ path = helixPath }, %)"
+      "// Create a helix around the Z axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 5,\n  length = 10,\n  radius = 5,\n  axis = 'Z'\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('YZ')\n  |> circle({ center = [0, 0], radius = 0.5 }, %)\n  |> sweep({ path = helixPath }, %)",
+      "// Create a helix around an edge.\nhelper001 = startSketchOn('XZ')\n  |> startProfileAt([0, 0], %)\n  |> line([0, 10], %, $edge001)\n\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 5,\n  length = 10,\n  radius = 5,\n  axis = edge001\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 0.5 }, %)\n  |> sweep({ path = helixPath }, %)",
+      "// Create a helix around a custom axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 5,\n  length = 10,\n  radius = 5,\n  axis = {\n    custom = {\n      axis = [0, 0, 1.0],\n      origin = [0, 0.25, 0]\n    }\n  }\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n  |> sweep({ path = helixPath }, %)"
     ]
   },
   {
@@ -193684,7 +193684,7 @@
     "deprecated": false,
     "examples": [
       "// Create a pipe using a sweep.\n\n\n// Create a path for the sweep.\nsweepPath = startSketchOn('XZ')\n  |> startProfileAt([0.05, 0.05], %)\n  |> line([0, 7], %)\n  |> tangentialArc({ offset = 90, radius = 5 }, %)\n  |> line([-3, 0], %)\n  |> tangentialArc({ offset = -90, radius = 5 }, %)\n  |> line([0, 7], %)\n\n// Create a hole for the pipe.\npipeHole = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 1.5 }, %)\n\nsweepSketch = startSketchOn('XY')\n  |> circle({ center = [0, 0], radius = 2 }, %)\n  |> hole(pipeHole, %)\n  |> sweep({ path = sweepPath }, %)",
-      "// Create a spring by sweeping around a helix path.\n\n\n// Create a helix around the Z axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 16,\n  length = 10,\n  radius = 5,\n  axis = 'Z'\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('YZ')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n// |> sweep({ path = helixPath }, %)"
+      "// Create a spring by sweeping around a helix path.\n\n\n// Create a helix around the Z axis.\nhelixPath = helix({\n  angleStart = 0,\n  ccw = true,\n  revolutions = 4,\n  length = 10,\n  radius = 5,\n  axis = 'Z'\n})\n\n// Create a spring by sweeping around the helix path.\nspringSketch = startSketchOn('YZ')\n  |> circle({ center = [0, 0], radius = 1 }, %)\n  |> sweep({ path = helixPath }, %)"
     ]
   },
   {

src/wasm-lib/kcl/src/std/helix.rs

@@ -50,7 +50,7 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// helixPath = helix({
 ///     angleStart = 0,
 ///     ccw = true,
-///     revolutions = 16,
+///     revolutions = 5,
 ///     length = 10,
 ///     radius = 5,
 ///     axis = 'Z',
@@ -59,8 +59,8 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 ///
 /// // Create a spring by sweeping around the helix path.
 /// springSketch = startSketchOn('YZ')
-///     |> circle({ center = [0, 0], radius = 1 }, %)
-///     //|> sweep({ path = helixPath }, %)
+///     |> circle({ center = [0, 0], radius = 0.5 }, %)
+///     |> sweep({ path = helixPath }, %)
 /// ```
 ///
 /// ```no_run
@@ -72,7 +72,7 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// helixPath = helix({
 ///     angleStart = 0,
 ///     ccw = true,
-///     revolutions = 16,
+///     revolutions = 5,
 ///     length = 10,
 ///     radius = 5,
 ///     axis = edge001,
@@ -80,8 +80,8 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 ///
 /// // Create a spring by sweeping around the helix path.
 /// springSketch = startSketchOn('XY')
-///     |> circle({ center = [0, 0], radius = 1 }, %)
-///     //|> sweep({ path = helixPath }, %)
+///     |> circle({ center = [0, 0], radius = 0.5 }, %)
+///     |> sweep({ path = helixPath }, %)
 /// ```
 ///
 /// ```no_run
@@ -89,7 +89,7 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// helixPath = helix({
 ///     angleStart = 0,
 ///     ccw = true,
-///     revolutions = 16,
+///     revolutions = 5,
 ///     length = 10,
 ///     radius = 5,
 ///     axis = {
@@ -103,7 +103,7 @@ pub async fn helix(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// // Create a spring by sweeping around the helix path.
 /// springSketch = startSketchOn('XY')
 ///     |> circle({ center = [0, 0], radius = 1 }, %)
-///     //|> sweep({ path = helixPath }, %)
+///     |> sweep({ path = helixPath }, %)
 /// ```
 #[stdlib {
     name = "helix",
@@ -137,7 +137,7 @@ async fn inner_helix(data: HelixData, exec_state: &mut ExecState, args: Args) ->
             };
 
             args.batch_modeling_cmd(
-                exec_state.next_uuid(),
+                id,
                 ModelingCmd::from(mcmd::EntityMakeHelixFromParams {
                     radius: data.radius,
                     is_clockwise: !data.ccw,
@@ -154,7 +154,7 @@ async fn inner_helix(data: HelixData, exec_state: &mut ExecState, args: Args) ->
             let edge_id = edge.get_engine_id(exec_state, &args)?;
 
             args.batch_modeling_cmd(
-                exec_state.next_uuid(),
+                id,
                 ModelingCmd::from(mcmd::EntityMakeHelixFromEdge {
                     radius: data.radius,
                     is_clockwise: !data.ccw,

src/wasm-lib/kcl/src/std/sweep.rs

@@ -94,7 +94,7 @@ pub async fn sweep(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// helixPath = helix({
 ///     angleStart = 0,
 ///     ccw = true,
-///     revolutions = 16,
+///     revolutions = 4,
 ///     length = 10,
 ///     radius = 5,
 ///     axis = 'Z',
@@ -104,7 +104,7 @@ pub async fn sweep(exec_state: &mut ExecState, args: Args) -> Result<KclValue, K
 /// // Create a spring by sweeping around the helix path.
 /// springSketch = startSketchOn('YZ')
 ///     |> circle({ center = [0, 0], radius = 1 }, %)
-///     //|> sweep({ path = helixPath }, %)
+///     |> sweep({ path = helixPath }, %)
 /// ```
 #[stdlib {
     name = "sweep",