Add default planes to std (#5433)

* Type ascription Signed-off-by: Nick Cameron <[email protected]> * Support negation of planes Signed-off-by: Nick Cameron <[email protected]> * Add default planes to std Signed-off-by: Nick Cameron <[email protected]> * Don't double wrap docs files in const_ Signed-off-by: Nick Cameron <[email protected]> --------- Signed-off-by: Nick Cameron <[email protected]>
KittyCAD · Feb 27, 2025 · 89bc93e · 89bc93e
1 parent 12edb63
commit 89bc93e
Show file tree

Hide file tree

Showing 50 changed files with 2,136 additions and 434 deletions.
diff --git a/docs/kcl/angledLine.md b/docs/kcl/angledLine.md
@@ -29,7 +29,7 @@ angledLine(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> yLineTo(15, %)
   |> angledLine({ angle = 30, length = 15 }, %)

diff --git a/docs/kcl/angledLineOfXLength.md b/docs/kcl/angledLineOfXLength.md
@@ -29,7 +29,7 @@ angledLineOfXLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XZ')
+sketch001 = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineOfXLength({ angle = 45, length = 10 }, %, $edge1)
   |> angledLineOfXLength({ angle = -15, length = 20 }, %, $edge2)

diff --git a/docs/kcl/angledLineOfYLength.md b/docs/kcl/angledLineOfYLength.md
@@ -29,7 +29,7 @@ angledLineOfYLength(data: AngledLineData, sketch: Sketch, tag?: TagDeclarator) -
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> angledLineOfYLength({ angle = 45, length = 10 }, %)

diff --git a/docs/kcl/angledLineThatIntersects.md b/docs/kcl/angledLineThatIntersects.md
@@ -29,7 +29,7 @@ angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch: Sketch, tag
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(endAbsolute = [5, 10])
   |> line(endAbsolute = [-10, 10], tag = $lineToIntersect)

diff --git a/docs/kcl/angledLineToX.md b/docs/kcl/angledLineToX.md
@@ -29,7 +29,7 @@ angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sk
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineToX({ angle = 30, to = 10 }, %)
   |> line(end = [0, 10])

diff --git a/docs/kcl/angledLineToY.md b/docs/kcl/angledLineToY.md
@@ -29,7 +29,7 @@ angledLineToY(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sk
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> angledLineToY({ angle = 60, to = 20 }, %)
   |> line(end = [-20, 0])

diff --git a/docs/kcl/arc.md b/docs/kcl/arc.md
@@ -31,7 +31,7 @@ arc(data: ArcData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [10, 0])
   |> arc({

diff --git a/docs/kcl/arcTo.md b/docs/kcl/arcTo.md
@@ -29,7 +29,7 @@ arcTo(data: ArcToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> arcTo({ end = [10, 0], interior = [5, 5] }, %)
   |> close()

diff --git a/docs/kcl/bezierCurve.md b/docs/kcl/bezierCurve.md
@@ -29,7 +29,7 @@ bezierCurve(data: BezierData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XZ')
+exampleSketch = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 10])
   |> bezierCurve({

diff --git a/docs/kcl/close.md b/docs/kcl/close.md
diff --git a/docs/kcl/const_E.md b/docs/kcl/const_E.md
diff --git a/docs/kcl/const_PI.md b/docs/kcl/const_PI.md
diff --git a/docs/kcl/const_QUARTER_TURN.md b/docs/kcl/const_QUARTER_TURN.md
diff --git a/docs/kcl/const_TAU.md b/docs/kcl/const_TAU.md
diff --git a/docs/kcl/const_THREE_QUARTER_TURN.md b/docs/kcl/const_THREE_QUARTER_TURN.md
diff --git a/docs/kcl/const_ZERO.md → docs/kcl/const_std-XY.md b/docs/kcl/const_ZERO.md → docs/kcl/const_std-XY.md
@@ -1,5 +1,5 @@
 ---
-title: "ZERO"
+title: "std::XY"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-ZERO: number = 0
+std::XY
 ```
 
 
diff --git a/docs/kcl/const_HALF_TURN.md → docs/kcl/const_std-XZ.md b/docs/kcl/const_HALF_TURN.md → docs/kcl/const_std-XZ.md
@@ -1,5 +1,5 @@
 ---
-title: "HALF_TURN"
+title: "std::XZ"
 excerpt: ""
 layout: manual
 ---
@@ -9,7 +9,7 @@ layout: manual
 
 
 ```js
-HALF_TURN: number(deg) = 180deg
+std::XZ
 ```
 
 
diff --git a/docs/kcl/const_std-YZ.md b/docs/kcl/const_std-YZ.md
@@ -0,0 +1,15 @@
+---
+title: "std::YZ"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+```js
+std::YZ
+```
+
+
diff --git a/docs/kcl/hole.md b/docs/kcl/hole.md
@@ -28,7 +28,7 @@ hole(holeSketch: SketchSet, sketch: Sketch) -> Sketch
 ### Examples
 
 ```js
-exampleSketch = startSketchOn('XY')
+exampleSketch = startSketchOn(XY)
   |> startProfileAt([0, 0], %)
   |> line(end = [0, 5])
   |> line(end = [5, 0])
@@ -44,7 +44,7 @@ example = extrude(exampleSketch, length = 1)
 
 ```js
 fn squareHoleSketch() {
-  squareSketch = startSketchOn('-XZ')
+  squareSketch = startSketchOn(-XZ)
     |> startProfileAt([-1, -1], %)
     |> line(end = [2, 0])
     |> line(end = [0, 2])
@@ -53,7 +53,7 @@ fn squareHoleSketch() {
   return squareSketch
 }
 
-exampleSketch = startSketchOn('-XZ')
+exampleSketch = startSketchOn(-XZ)
   |> circle({ center = [0, 0], radius = 3 }, %)
   |> hole(squareHoleSketch(), %)
 example = extrude(exampleSketch, length = 1)

diff --git a/docs/kcl/index.md b/docs/kcl/index.md
@@ -19,6 +19,9 @@ layout: manual
   * [`HALF_TURN`](kcl/const_std-HALF_TURN)
   * [`QUARTER_TURN`](kcl/const_std-QUARTER_TURN)
   * [`THREE_QUARTER_TURN`](kcl/const_std-THREE_QUARTER_TURN)
+  * [`XY`](kcl/const_std-XY)
+  * [`XZ`](kcl/const_std-XZ)
+  * [`YZ`](kcl/const_std-YZ)
   * [`ZERO`](kcl/const_std-ZERO)
   * [`abs`](kcl/abs)
   * [`acos`](kcl/acos)

diff --git a/docs/kcl/line.md b/docs/kcl/line.md
@@ -30,7 +30,7 @@ line(sketch: Sketch, endAbsolute?: [number], end?: [number], tag?: TagDeclarator
 ### Examples
 
 ```js
-triangle = startSketchOn("XZ")
+triangle = startSketchOn(XZ)
   |> startProfileAt([0, 0], %)
   // The 'end' argument means it ends at exactly [10, 0].
   // This is an absolute measurement, it is NOT relative to
@@ -41,7 +41,7 @@ triangle = startSketchOn("XZ")
   |> close()
   |> extrude(length = 5)
 
-box = startSketchOn("XZ")
+box = startSketchOn(XZ)
   |> startProfileAt([10, 10], %)
   // The 'to' argument means move the pen this much.
   // So, [10, 0] is a relative distance away from the current point.

diff --git a/docs/kcl/profileStart.md b/docs/kcl/profileStart.md
@@ -27,7 +27,7 @@ profileStart(sketch: Sketch) -> [number]
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine({ angle = 120, length = 50 }, %, $seg01)
   |> angledLine({

diff --git a/docs/kcl/profileStartX.md b/docs/kcl/profileStartX.md
@@ -27,7 +27,7 @@ profileStartX(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine([-26.6, 50], %)
   |> angledLine([90, 50], %)

diff --git a/docs/kcl/profileStartY.md b/docs/kcl/profileStartY.md
@@ -27,7 +27,7 @@ profileStartY(sketch: Sketch) -> number
 ### Examples
 
 ```js
-sketch001 = startSketchOn('XY')
+sketch001 = startSketchOn(XY)
   |> startProfileAt([5, 2], %)
   |> angledLine({ angle = -60, length = 14 }, %)
   |> angledLineToY({ angle = 30, to = profileStartY(%) }, %)

diff --git a/docs/kcl/startProfileAt.md b/docs/kcl/startProfileAt.md
diff --git a/docs/kcl/startSketchOn.md b/docs/kcl/startSketchOn.md