Add units to geometry types

Signed-off-by: Nick Cameron <[email protected]>
KittyCAD · Jan 21, 2025 · 695a470 · 695a470
1 parent 6d585bd
commit 695a470
Show file tree

Hide file tree

Showing 60 changed files with 25,628 additions and 6,560 deletions.
diff --git a/docs/kcl/std.json b/docs/kcl/std.json
diff --git a/docs/kcl/types/Face.md b/docs/kcl/types/Face.md
@@ -22,6 +22,7 @@ A face.
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
 | `solid` |[`Solid`](/docs/kcl/types/Solid)| The solid the face is on. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A face. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
diff --git a/docs/kcl/types/Helix.md b/docs/kcl/types/Helix.md
@@ -20,6 +20,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
diff --git a/docs/kcl/types/HelixValue.md b/docs/kcl/types/HelixValue.md
@@ -20,6 +20,7 @@ A helix.
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A helix. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
diff --git a/docs/kcl/types/Plane.md b/docs/kcl/types/Plane.md
@@ -22,6 +22,7 @@ A plane.
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A plane. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
diff --git a/docs/kcl/types/Sketch.md b/docs/kcl/types/Sketch.md
@@ -21,6 +21,7 @@ A sketch is a collection of paths.
 | `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch is a collection of paths. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 
 
diff --git a/docs/kcl/types/SketchSet.md b/docs/kcl/types/SketchSet.md
@@ -30,6 +30,7 @@ A sketch is a collection of paths.
 | `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch or a group of sketches. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 
 

diff --git a/docs/kcl/types/SketchSurface.md b/docs/kcl/types/SketchSurface.md
@@ -31,6 +31,7 @@ A plane.
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch type. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 
@@ -54,6 +55,7 @@ A face.
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |
 | `zAxis` |[`Point3d`](/docs/kcl/types/Point3d)| The z-axis (normal). | No |
 | `solid` |[`Solid`](/docs/kcl/types/Solid)| The solid the face is on. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch type. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`|  | No |
 
 

diff --git a/docs/kcl/types/Solid.md b/docs/kcl/types/Solid.md
@@ -23,6 +23,7 @@ An solid is a collection of extrude surfaces.
 | `startCapId` |`string`| The id of the extrusion start cap | No |
 | `endCapId` |`string`| The id of the extrusion end cap | No |
 | `edgeCuts` |`[` [`EdgeCut`](/docs/kcl/types/EdgeCut) `]`| Chamfers or fillets on this solid. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| An solid is a collection of extrude surfaces. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 
 
diff --git a/docs/kcl/types/SolidSet.md b/docs/kcl/types/SolidSet.md
@@ -32,6 +32,7 @@ An solid is a collection of extrude surfaces.
 | `startCapId` |`string`| The id of the extrusion start cap | No |
 | `endCapId` |`string`| The id of the extrusion end cap | No |
 | `edgeCuts` |`[` [`EdgeCut`](/docs/kcl/types/EdgeCut) `]`| Chamfers or fillets on this solid. | No |
+| `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A solid or a group of solids. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 
 

diff --git a/docs/kcl/types/UnitLen.md b/docs/kcl/types/UnitLen.md
@@ -0,0 +1,107 @@
+---
+title: "UnitLen"
+excerpt: ""
+layout: manual
+---
+
+
+
+
+
+
+**This schema accepts exactly one of the following:**
+
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `Mm`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `Cm`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `M`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `Inches`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `Feet`|  | No |
+
+
+----
+
+**Type:** `object`
+
+
+
+
+
+## Properties
+
+| Property | Type | Description | Required |
+|----------|------|-------------|----------|
+| `type` |enum: `Yards`|  | No |
+
+
+----
+
+
+
+
diff --git a/src/lang/artifact.test.ts b/src/lang/artifact.test.ts
@@ -54,6 +54,9 @@ const mySketch001 = startSketchOn('XY')
           },
         ],
         id: expect.any(String),
+        units: {
+          type: 'Mm',
+        },
         __meta: [{ sourceRange: [46, 71, 0] }],
       },
     })
@@ -93,6 +96,9 @@ const mySketch001 = startSketchOn('XY')
         ],
         sketch: {
           id: expect.any(String),
+          units: {
+            type: 'Mm',
+          },
           __meta: expect.any(Array),
           on: expect.any(Object),
           start: expect.any(Object),
@@ -123,6 +129,9 @@ const mySketch001 = startSketchOn('XY')
         height: 2,
         startCapId: expect.any(String),
         endCapId: expect.any(String),
+        units: {
+          type: 'Mm',
+        },
         __meta: [{ sourceRange: [46, 71, 0] }],
       },
     })
@@ -194,6 +203,9 @@ const sk2 = startSketchOn('XY')
             on: expect.any(Object),
             start: expect.any(Object),
             type: 'Sketch',
+            units: {
+              type: 'Mm',
+            },
             tags: {
               p: {
                 __meta: [
@@ -247,6 +259,9 @@ const sk2 = startSketchOn('XY')
           height: 2,
           startCapId: expect.any(String),
           endCapId: expect.any(String),
+          units: {
+            type: 'Mm',
+          },
           __meta: [{ sourceRange: [38, 63, 0] }],
         },
       },
@@ -285,6 +300,9 @@ const sk2 = startSketchOn('XY')
           ],
           sketch: {
             id: expect.any(String),
+            units: {
+              type: 'Mm',
+            },
             __meta: expect.any(Array),
             on: expect.any(Object),
             start: expect.any(Object),
@@ -343,6 +361,9 @@ const sk2 = startSketchOn('XY')
           startCapId: expect.any(String),
           endCapId: expect.any(String),
           __meta: [{ sourceRange: [342, 367, 0] }],
+          units: {
+            type: 'Mm',
+          },
         },
       },
     ])

diff --git a/src/lang/executor.test.ts b/src/lang/executor.test.ts
@@ -221,6 +221,9 @@ const newVar = myVar + 1`
           },
         ],
         id: expect.any(String),
+        units: {
+          type: 'Mm',
+        },
         __meta: [{ sourceRange: [39, 63, 0] }],
       },
     })

diff --git a/src/wasm-lib/kcl/src/execution/mod.rs b/src/wasm-lib/kcl/src/execution/mod.rs
@@ -759,6 +759,7 @@ pub struct Helix {
     pub angle_start: f64,
     /// Is the helix rotation counter clockwise?
     pub ccw: bool,
+    pub units: UnitLen,
     #[serde(rename = "__meta")]
     pub meta: Vec<Metadata>,
 }
@@ -780,6 +781,7 @@ pub struct Plane {
     pub y_axis: Point3d,
     /// The z-axis (normal).
     pub z_axis: Point3d,
+    pub units: UnitLen,
     #[serde(rename = "__meta")]
     pub meta: Vec<Metadata>,
 }
@@ -795,6 +797,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 1.0, 0.0),
                 z_axis: Point3d::new(0.0, 0.0, 1.0),
                 value: PlaneType::XY,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::NegXY => Plane {
@@ -804,6 +807,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 1.0, 0.0),
                 z_axis: Point3d::new(0.0, 0.0, -1.0),
                 value: PlaneType::XY,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::XZ => Plane {
@@ -813,6 +817,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 0.0, 1.0),
                 z_axis: Point3d::new(0.0, -1.0, 0.0),
                 value: PlaneType::XZ,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::NegXZ => Plane {
@@ -822,6 +827,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 0.0, 1.0),
                 z_axis: Point3d::new(0.0, 1.0, 0.0),
                 value: PlaneType::XZ,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::YZ => Plane {
@@ -831,6 +837,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 0.0, 1.0),
                 z_axis: Point3d::new(1.0, 0.0, 0.0),
                 value: PlaneType::YZ,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::NegYZ => Plane {
@@ -840,6 +847,7 @@ impl Plane {
                 y_axis: Point3d::new(0.0, 0.0, 1.0),
                 z_axis: Point3d::new(-1.0, 0.0, 0.0),
                 value: PlaneType::YZ,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
             crate::std::sketch::PlaneData::Plane {
@@ -854,6 +862,7 @@ impl Plane {
                 y_axis: *y_axis,
                 z_axis: *z_axis,
                 value: PlaneType::Custom,
+                units: exec_state.length_unit(),
                 meta: vec![],
             },
         }
@@ -900,6 +909,7 @@ pub struct Face {
     pub z_axis: Point3d,
     /// The solid the face is on.
     pub solid: Box<Solid>,
+    pub units: UnitLen,
     #[serde(rename = "__meta")]
     pub meta: Vec<Metadata>,
 }
@@ -1018,6 +1028,7 @@ pub struct Sketch {
     /// is sketched on face etc.
     #[serde(skip)]
     pub original_id: uuid::Uuid,
+    pub units: UnitLen,
     /// Metadata.
     #[serde(rename = "__meta")]
     pub meta: Vec<Metadata>,
@@ -1141,6 +1152,7 @@ pub struct Solid {
     /// Chamfers or fillets on this solid.
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub edge_cuts: Vec<EdgeCut>,
+    pub units: UnitLen,
     /// Metadata.
     #[serde(rename = "__meta")]
     pub meta: Vec<Metadata>,

diff --git a/src/wasm-lib/kcl/src/std/args.rs b/src/wasm-lib/kcl/src/std/args.rs
@@ -863,27 +863,7 @@ impl<'a> FromKclValue<'a> for crate::std::planes::StandardPlane {
 
 impl<'a> FromKclValue<'a> for crate::execution::Plane {
     fn from_kcl_val(arg: &'a KclValue) -> Option<Self> {
-        if let Some(plane) = arg.as_plane() {
-            return Some(plane.clone());
-        }
-
-        let obj = arg.as_object()?;
-        let_field_of!(obj, id);
-        let_field_of!(obj, value);
-        let_field_of!(obj, origin);
-        let_field_of!(obj, x_axis "xAxis");
-        let_field_of!(obj, y_axis "yAxis");
-        let_field_of!(obj, z_axis "zAxis");
-        let_field_of!(obj, meta "__meta");
-        Some(Self {
-            id,
-            value,
-            origin,
-            x_axis,
-            y_axis,
-            z_axis,
-            meta,
-        })
+        arg.as_plane().cloned()
     }
 }