allow for sketching on the face of a chamfer in kcl (#2760)

* updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * lots of cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * lots more cleanup Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * more cleaniup Signed-off-by: Jess Frazelle <github@jessfraz.com> * fix typos Signed-off-by: Jess Frazelle <github@jessfraz.com> * add to known issues Signed-off-by: Jess Frazelle <github@jessfraz.com> * fixes Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
KittyCAD · Jun 24, 2024 · 5260bd6 · 5260bd6
1 parent 3946532
commit 5260bd6
Show file tree

Hide file tree

Showing 59 changed files with 991 additions and 279 deletions.
diff --git a/docs/kcl/KNOWN-ISSUES.md b/docs/kcl/KNOWN-ISSUES.md
@@ -23,5 +23,7 @@ once fixed in engine will just start working here with no language changes.
 - **Chamfers**: Chamfers cannot intersect, you will get an error. Only simple
     chamfer cases work currently.
 
+    Sketching on the chamfered face does not currently work.
+
 - **Shell**: Shell is only working for `end` faces, not for `side` or `start` 
     faces. We are tracking the engine side bug on this.
diff --git a/docs/kcl/angleToMatchLengthX.md b/docs/kcl/angleToMatchLengthX.md
@@ -90,6 +90,7 @@ const extrusion = extrude(5, sketch001)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angleToMatchLengthY.md b/docs/kcl/angleToMatchLengthY.md
@@ -91,6 +91,7 @@ const extrusion = extrude(5, sketch001)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md
@@ -97,6 +97,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -371,6 +372,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md
@@ -96,6 +96,7 @@ const extrusion = extrude(10, sketch001)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -370,6 +371,7 @@ const extrusion = extrude(10, sketch001)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLineOfYLength.md b/docs/kcl/angledLineOfYLength.md
@@ -98,6 +98,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -372,6 +373,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md
@@ -102,6 +102,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -376,6 +377,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLineToX.md b/docs/kcl/angledLineToX.md
@@ -95,6 +95,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -369,6 +370,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/angledLineToY.md b/docs/kcl/angledLineToY.md
@@ -95,6 +95,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -369,6 +370,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md
@@ -106,6 +106,7 @@ const exampleSketch = startSketchOn('XZ')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -380,6 +381,7 @@ const exampleSketch = startSketchOn('XZ')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md
@@ -101,6 +101,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -375,6 +376,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/chamfer.md b/docs/kcl/chamfer.md
@@ -9,7 +9,7 @@ Create chamfers on tagged paths.
 
 
 ```js
-chamfer(data: ChamferData, extrude_group: ExtrudeGroup) -> ExtrudeGroup
+chamfer(data: ChamferData, extrude_group: ExtrudeGroup, tag?: String) -> ExtrudeGroup
 ```
 
 ### Examples
@@ -73,6 +73,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -135,6 +136,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -295,6 +297,7 @@ string],
 }],
 }
 ```
+* `tag`: `String` (OPTIONAL)
 
 ### Returns
 
@@ -318,6 +321,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -380,6 +384,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/circle.md b/docs/kcl/circle.md
@@ -95,6 +95,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -287,6 +288,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -481,6 +483,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/close.md b/docs/kcl/close.md
@@ -96,6 +96,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -370,6 +371,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/extrude.md b/docs/kcl/extrude.md
@@ -121,6 +121,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -361,6 +362,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -423,6 +425,7 @@ const example = extrude(10, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/fillet.md b/docs/kcl/fillet.md
@@ -73,6 +73,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -135,6 +136,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -318,6 +320,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -380,6 +383,7 @@ string],
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/getEdge.md b/docs/kcl/getEdge.md
@@ -60,6 +60,7 @@ const revolution = startSketchOn(box, "revolveAxis")
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -122,6 +123,7 @@ const revolution = startSketchOn(box, "revolveAxis")
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/getNextAdjacentEdge.md b/docs/kcl/getNextAdjacentEdge.md
@@ -58,6 +58,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -120,6 +121,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/getOppositeEdge.md b/docs/kcl/getOppositeEdge.md
@@ -56,6 +56,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -118,6 +119,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/getPreviousAdjacentEdge.md b/docs/kcl/getPreviousAdjacentEdge.md
@@ -58,6 +58,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -120,6 +121,7 @@ const example = extrude(5, exampleSketch)
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.

diff --git a/docs/kcl/helix.md b/docs/kcl/helix.md
@@ -63,6 +63,7 @@ const part001 = startSketchOn('XY')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -125,6 +126,7 @@ const part001 = startSketchOn('XY')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -308,6 +310,7 @@ const part001 = startSketchOn('XY')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.
@@ -370,6 +373,7 @@ const part001 = startSketchOn('XY')
 	// The id of the engine command that called this chamfer.
 	id: uuid,
 	length: number,
+	tag: string,
 	type: "chamfer",
 }],
 	// The height of the extrude group.