ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Recusive docs (#4023)

Browse Source 
updates



updates



updates



updates



updates



updates



better



updates



array of



updates



updates



updates



updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2024-09-27 19:50:44 -07:00
committed by GitHub
parent 37bb696a30
commit 790af3842c
50 changed files with 474 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/kcl/arrayReduce.md
View File

@ -17,7 +17,7 @@ arrayReduce(array: [u64], start: Sketch, reduce_fn: FunctionParam) -> Sketch
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `array` | [`[u64]`](/docs/kcl/types/[u64]) | | Yes |
| `array` | `[u64]` | | Yes |
| `start` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
| `reduce_fn` | `FunctionParam` | | Yes |

2
docs/kcl/line.md
View File

@ -17,7 +17,7 @@ line(delta: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `delta` | `[number]` | | Yes |
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |

2
docs/kcl/lineTo.md
View File

@ -17,7 +17,7 @@ lineTo(to: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `to` | `[number]` | | Yes |
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |

2
docs/kcl/loft.md
View File

@ -17,7 +17,7 @@ loft(sketches: [Sketch], data?: LoftData) -> Solid
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `sketches` | [`[Sketch]`](/docs/kcl/types/[Sketch]) | | Yes |
| `sketches` | [`[Sketch]`](/docs/kcl/types/Sketch) | | Yes |
| `data` | [`LoftData`](/docs/kcl/types/LoftData) | Data for a loft. | No |
### Returns

2
docs/kcl/max.md
View File

@ -21,7 +21,7 @@ max(args: [number]) -> number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `args` | `[number]` | | Yes |
### Returns

2
docs/kcl/min.md
View File

@ -21,7 +21,7 @@ min(args: [number]) -> number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `args` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `args` | `[number]` | | Yes |
### Returns

2
docs/kcl/mirror2d.md
View File

@ -23,7 +23,7 @@ mirror2d(data: Mirror2dData, sketch_set: SketchSet) -> [Sketch]
### Returns
[`[Sketch]`](/docs/kcl/types/[Sketch])
[`[Sketch]`](/docs/kcl/types/Sketch)
### Examples

2
docs/kcl/patternCircular2d.md
View File

@ -22,7 +22,7 @@ patternCircular2d(data: CircularPattern2dData, sketch_set: SketchSet) -> [Sketch
### Returns
[`[Sketch]`](/docs/kcl/types/[Sketch])
[`[Sketch]`](/docs/kcl/types/Sketch)
### Examples

2
docs/kcl/patternCircular3d.md
View File

@ -22,7 +22,7 @@ patternCircular3d(data: CircularPattern3dData, solid_set: SolidSet) -> [Solid]
### Returns
[`[Solid]`](/docs/kcl/types/[Solid])
[`[Solid]`](/docs/kcl/types/Solid)
### Examples

2
docs/kcl/patternLinear2d.md
View File

@ -22,7 +22,7 @@ patternLinear2d(data: LinearPattern2dData, sketch_set: SketchSet) -> [Sketch]
### Returns
[`[Sketch]`](/docs/kcl/types/[Sketch])
[`[Sketch]`](/docs/kcl/types/Sketch)
### Examples

2
docs/kcl/patternLinear3d.md
View File

@ -22,7 +22,7 @@ patternLinear3d(data: LinearPattern3dData, solid_set: SolidSet) -> [Solid]
### Returns
[`[Solid]`](/docs/kcl/types/[Solid])
[`[Solid]`](/docs/kcl/types/Solid)
### Examples

2
docs/kcl/patternTransform.md
View File

@ -25,7 +25,7 @@ patternTransform(total_instances: u32, transform_function: FunctionParam, solid_
### Returns
[`[Solid]`](/docs/kcl/types/[Solid])
[`[Solid]`](/docs/kcl/types/Solid)
### Examples

2
docs/kcl/polar.md
View File

@ -21,7 +21,7 @@ polar(data: PolarCoordsData) -> [number]
### Returns
[`[number]`](/docs/kcl/types/[number])
`[number]`
### Examples

2
docs/kcl/profileStart.md
View File

@ -21,7 +21,7 @@ profileStart(sketch: Sketch) -> [number]
### Returns
[`[number]`](/docs/kcl/types/[number])
`[number]`
### Examples

2
docs/kcl/startProfileAt.md
View File

@ -17,7 +17,7 @@ startProfileAt(to: [number], sketch_surface: SketchSurface, tag?: TagDeclarator)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `to` | `[number]` | | Yes |
| `sketch_surface` | [`SketchSurface`](/docs/kcl/types/SketchSurface) | A sketch type. | Yes |
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |

2
docs/kcl/startSketchAt.md
View File

@ -17,7 +17,7 @@ startSketchAt(data: [number]) -> Sketch
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `data` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `data` | `[number]` | | Yes |
### Returns

2
docs/kcl/tangentialArcTo.md
View File

@ -17,7 +17,7 @@ tangentialArcTo(to: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `to` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `to` | `[number]` | | Yes |
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |

2
docs/kcl/tangentialArcToRelative.md
View File

@ -17,7 +17,7 @@ tangentialArcToRelative(delta: [number], sketch: Sketch, tag?: TagDeclarator) ->
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `delta` | [`[number]`](/docs/kcl/types/[number]) | | Yes |
| `delta` | `[number]` | | Yes |
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |

7
docs/kcl/types/AngledLineData.md
View File

@ -13,17 +13,10 @@ Data to draw an angled line.
An angle and length with explicitly named parameters
**Type:** `object`
## Properties
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` |`number` (`double`)| The angle of the line (in degrees). | No |
| `length` |`number` (`double`)| The length of the line. | No |
----

6
docs/kcl/types/AngledLineThatIntersectsData.md
View File

@ -16,8 +16,8 @@ Data for drawing an angled line that intersects with a given line.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` |`number` (`double`)| The angle of the line. | No |
| `intersectTag` |`object`| The tag of the line to intersect with. | No |
| `offset` |`number` (`double`)| The offset from the intersecting line. | No |
| `angle` |`number`| The angle of the line. | No |
| `intersectTag` |[`TagIdentifier`](/docs/kcl/types#tag-identifier)| The tag of the line to intersect with. | No |
| `offset` |`number`| The offset from the intersecting line. | No |

4
docs/kcl/types/AngledLineToData.md
View File

@ -16,7 +16,7 @@ Data to draw an angled line to a point.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` |`number` (`double`)| The angle of the line. | No |
| `to` |`number` (`double`)| The point to draw to. | No |
| `angle` |`number`| The angle of the line. | No |
| `to` |`number`| The point to draw to. | No |

12
docs/kcl/types/ArcData.md
View File

@ -22,9 +22,9 @@ Angles and radius with an optional tag.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angleStart` |`number` (`double`)| The start angle. | No |
| `angleEnd` |`number` (`double`)| The end angle. | No |
| `radius` |`number` (`double`)| The radius. | No |
| `angleStart` |`number`| The start angle. | No |
| `angleEnd` |`number`| The end angle. | No |
| `radius` |`number`| The radius. | No |
----
@ -40,9 +40,9 @@ Center, to and radius with an optional tag.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `center` |`array`| The center. | No |
| `to` |`array`| The to point. | No |
| `radius` |`number` (`double`)| The radius. | No |
| `center` |`[number, number]`| The center. | No |
| `to` |`[number, number]`| The to point. | No |
| `radius` |`number`| The radius. | No |
----

6
docs/kcl/types/BezierData.md
View File

@ -16,8 +16,8 @@ Data to draw a bezier curve.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `to` |`array`| The to point. | No |
| `control1` |`array`| The first control point. | No |
| `control2` |`array`| The second control point. | No |
| `to` |`[number, number]`| The to point. | No |
| `control1` |`[number, number]`| The first control point. | No |
| `control2` |`[number, number]`| The second control point. | No |

4
docs/kcl/types/ChamferData.md
View File

@ -16,7 +16,7 @@ Data for chamfers.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `length` |`number` (`double`)| The length of the chamfer. | No |
| `tags` |`array`| The tags of the paths you want to chamfer. | No |
| `length` |`number`| The length of the chamfer. | No |
| `tags` |`[` **anyOf:** `string` **OR** [`TagIdentifier`](/docs/kcl/types#tag-identifier) `]`| The tags of the paths you want to chamfer. | No |

4
docs/kcl/types/CircleData.md
View File

@ -16,7 +16,7 @@ Data for drawing an circle
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `center` |`array`| The center of the circle. | No |
| `radius` |`number` (`double`)| The circle radius | No |
| `center` |`[number, number]`| The center of the circle. | No |
| `radius` |`number`| The circle radius | No |

6
docs/kcl/types/CircularPattern2dData.md
View File

@ -16,9 +16,9 @@ Data for a circular pattern on a 2D sketch.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `center` |`array`| The center about which to make the pattern. This is a 2D vector. | No |
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
| `repetitions` |`integer`| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `center` |`[number, number]`| The center about which to make the pattern. This is a 2D vector. | No |
| `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |

8
docs/kcl/types/CircularPattern3dData.md
View File

@ -16,10 +16,10 @@ Data for a circular pattern on a 3D model.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `axis` |`array`| The axis around which to make the pattern. This is a 3D vector. | No |
| `center` |`array`| The center about which to make the pattern. This is a 3D vector. | No |
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
| `repetitions` |`integer`| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `axis` |`[number, number, number]`| The axis around which to make the pattern. This is a 3D vector. | No |
| `center` |`[number, number, number]`| The center about which to make the pattern. This is a 3D vector. | No |
| `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |

8
docs/kcl/types/FaceTag.md
View File

@ -46,18 +46,10 @@ The end face after you extruded. This could also be known as the top face. But w
A tag for the face.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `value` |`string`| | No |
| `info` |`object`| Engine information for a tag. | No |
| `__meta` |`array`| | No |
----

6
docs/kcl/types/FilletData.md
View File

@ -16,8 +16,8 @@ Data for fillets.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `radius` |`number` (`double`)| The radius of the fillet. | No |
| `tags` |`array`| The tags of the paths you want to fillet. | No |
| `tolerance` |`number` (`double`)| The tolerance for the fillet. | No |
| `radius` |`number`| The radius of the fillet. | No |
| `tags` |`[` **anyOf:** `string` **OR** [`TagIdentifier`](/docs/kcl/types#tag-identifier) `]`| The tags of the paths you want to fillet. | No |
| `tolerance` |`number`| The tolerance for the fillet. | No |

6
docs/kcl/types/HelixData.md
View File

@ -16,9 +16,9 @@ Data for helices.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `revolutions` |`number` (`double`)| Number of revolutions. | No |
| `angleStart` |`number` (`double`)| Start angle (in degrees). | No |
| `revolutions` |`number`| Number of revolutions. | No |
| `angleStart` |`number`| Start angle (in degrees). | No |
| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is &#x60;false&#x60;. | No |
| `length` |`number` (`double`)| Length of the helix. If this argument is not provided, the height of the solid is used. | No |
| `length` |`number`| Length of the helix. If this argument is not provided, the height of the solid is used. | No |

6
docs/kcl/types/ImportFormat.md
View File

@ -57,7 +57,7 @@ Wavefront OBJ format.
|----------|------|-------------|----------|
| `type` |enum: `obj`| | No |
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
| `units` |`oneOf`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
| `units` |**oneOf:** enum: `cm` **OR** enum: `ft` **OR** enum: `in` **OR** enum: `m` **OR** enum: `mm` **OR** enum: `yd`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
----
@ -75,7 +75,7 @@ The PLY Polygon File Format.
|----------|------|-------------|----------|
| `type` |enum: `ply`| | No |
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
| `units` |`oneOf`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
| `units` |**oneOf:** enum: `cm` **OR** enum: `ft` **OR** enum: `in` **OR** enum: `m` **OR** enum: `mm` **OR** enum: `yd`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
----
@ -125,7 +125,7 @@ ST**ereo**L**ithography format.
|----------|------|-------------|----------|
| `type` |enum: `stl`| | No |
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
| `units` |`oneOf`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
| `units` |**oneOf:** enum: `cm` **OR** enum: `ft` **OR** enum: `in` **OR** enum: `m` **OR** enum: `mm` **OR** enum: `yd`| The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters. | No |
----

6
docs/kcl/types/ImportedGeometry.md
View File

@ -16,8 +16,8 @@ Data for an imported geometry.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `id` |`string` (`uuid`)| The ID of the imported geometry. | No |
| `value` |`array`| The original file paths. | No |
| `__meta` |`array`| | No |
| `id` |`string`| The ID of the imported geometry. | No |
| `value` |`[` `string` `]`| The original file paths. | No |
| `__meta` |`[` `object` `]`| | No |

6
docs/kcl/types/LinearPattern2dData.md
View File

@ -16,8 +16,8 @@ Data for a linear pattern on a 2D sketch.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `distance` |`number` (`double`)| The distance between each repetition. This can also be referred to as spacing. | No |
| `axis` |`array`| The axis of the pattern. This is a 2D vector. | No |
| `repetitions` |`integer`| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `distance` |`number`| The distance between each repetition. This can also be referred to as spacing. | No |
| `axis` |`[number, number]`| The axis of the pattern. This is a 2D vector. | No |

6
docs/kcl/types/LinearPattern3dData.md
View File

@ -16,8 +16,8 @@ Data for a linear pattern on a 3D model.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `distance` |`number` (`double`)| The distance between each repetition. This can also be referred to as spacing. | No |
| `axis` |`array`| The axis of the pattern. | No |
| `repetitions` |`integer`| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if &#x60;repetitions&#x60; is 1, the original entity will be copied once. | No |
| `distance` |`number`| The distance between each repetition. This can also be referred to as spacing. | No |
| `axis` |`[number, number, number]`| The axis of the pattern. | No |

6
docs/kcl/types/LoftData.md
View File

@ -16,9 +16,9 @@ Data for a loft.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `vDegree` |`integer` (`uint32`)| 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. | No |
| `vDegree` |`integer`| 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. | No |
| `bezApproximateRational` |`boolean`| 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&#x27;t be necessary. | No |
| `baseCurveIndex` |`integer` (`uint32`)| This can be set to override the automatically determined topological base curve, which is usually the first section encountered. | No |
| `tolerance` |`number` (`double`)| Tolerance for the loft operation. | No |
| `baseCurveIndex` |`integer`| This can be set to override the automatically determined topological base curve, which is usually the first section encountered. | No |
| `tolerance` |`number`| Tolerance for the loft operation. | No |

2
docs/kcl/types/Mirror2dData.md
View File

@ -16,6 +16,6 @@ Data for a mirror.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `axis` |`anyOf`| Axis to use as mirror. | No |
| `axis` |**anyOf:** **oneOf:** enum: `X` **OR** enum: `Y` **OR** enum: `-X` **OR** enum: `-Y` **OR** `object` **OR** **anyOf:** `string` **OR** [`TagIdentifier`](/docs/kcl/types#tag-identifier)| Axis to use as mirror. | No |

4
docs/kcl/types/PolarCoordsData.md
View File

@ -16,7 +16,7 @@ Data for polar coordinates.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` |`number` (`double`)| The angle of the line (in degrees). | No |
| `length` |`number` (`double`)| The length of the line. | No |
| `angle` |`number`| The angle of the line (in degrees). | No |
| `length` |`number`| The length of the line. | No |

6
docs/kcl/types/RevolveData.md
View File

@ -16,8 +16,8 @@ Data for revolution surfaces.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` |`number` (`double`)| Angle to revolve (in degrees). Default is 360. | No |
| `axis` |`anyOf`| Axis of revolution. | No |
| `tolerance` |`number` (`double`)| Tolerance for the revolve operation. | No |
| `angle` |`number`| Angle to revolve (in degrees). Default is 360. | No |
| `axis` |**anyOf:** **oneOf:** enum: `X` **OR** enum: `Y` **OR** enum: `-X` **OR** enum: `-Y` **OR** `object` **OR** **anyOf:** `string` **OR** [`TagIdentifier`](/docs/kcl/types#tag-identifier)| Axis of revolution. | No |
| `tolerance` |`number`| Tolerance for the revolve operation. | No |

4
docs/kcl/types/ShellData.md
View File

@ -16,7 +16,7 @@ Data for shells.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `thickness` |`number` (`double`)| The thickness of the shell. | No |
| `faces` |`array`| The faces you want removed. | No |
| `thickness` |`number`| The thickness of the shell. | No |
| `faces` |`[` **anyOf:** **oneOf:** enum: `start` **OR** enum: `end` **OR** [`TagIdentifier`](/docs/kcl/types#tag-identifier) `]`| The faces you want removed. | No |

8
docs/kcl/types/Sketch.md
View File

@ -16,11 +16,11 @@ A sketch is a collection of paths.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `id` |`string` (`uuid`)| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`array`| The paths in the sketch. | No |
| `on` |`oneOf`| What the sketch is on (can be a plane or a face). | No |
| `id` |`string`| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The paths in the sketch. | No |
| `on` |**oneOf:** `object` **OR** `object`| What the sketch is on (can be a plane or a face). | No |
| `start` |`object`| The starting path. | No |
| `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
| `__meta` |`array`| Metadata. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |

98
docs/kcl/types/SketchData.md
View File

@ -15,90 +15,6 @@ Data for a plane.
**This schema accepts exactly one of the following:**
The XY plane.
**enum:** `XY`
----
The opposite side of the XY plane.
**enum:** `-XY`
----
The XZ plane.
**enum:** `XZ`
----
The opposite side of the XZ plane.
**enum:** `-XZ`
----
The YZ plane.
**enum:** `YZ`
----
The opposite side of the YZ plane.
**enum:** `-YZ`
----
A defined plane.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `plane` |`object`| | No |
----
@ -116,14 +32,14 @@ An solid is a collection of extrude surfaces.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `id` |`string` (`uuid`)| The id of the solid. | No |
| `value` |`array`| The extrude surfaces. | No |
| `id` |`string`| The id of the solid. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The extrude surfaces. | No |
| `sketch` |`object`| The sketch. | No |
| `height` |`number` (`double`)| The height of the solid. | No |
| `startCapId` |`string` (`uuid`)| The id of the extrusion start cap | No |
| `endCapId` |`string` (`uuid`)| The id of the extrusion end cap | No |
| `edgeCuts` |`array`| Chamfers or fillets on this solid. | No |
| `__meta` |`array`| Metadata. | No |
| `height` |`number`| The height of the solid. | No |
| `startCapId` |`string`| The id of the extrusion start cap | No |
| `endCapId` |`string`| The id of the extrusion end cap | No |
| `edgeCuts` |`[` **oneOf:** `object` **OR** `object` `]`| Chamfers or fillets on this solid. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |
----

18
docs/kcl/types/SketchOrSurface.md
View File

@ -30,13 +30,13 @@ A plane.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `plane`| | No |
| `id` |`string` (`uuid`)| The id of the plane. | No |
| `value` |`oneOf`| Type for a plane. | No |
| `id` |`string`| The id of the plane. | No |
| `value` |**oneOf:** enum: `XY`, `XZ`, `YZ` **OR** enum: `Custom`| Type for a plane. | No |
| `origin` |`object`| Origin of the plane. | No |
| `xAxis` |`object`| What should the plane’s X axis be? | No |
| `yAxis` |`object`| What should the plane’s Y axis be? | No |
| `zAxis` |`object`| The z-axis (normal). | No |
| `__meta` |`array`| | No |
| `__meta` |`[` `object` `]`| | No |
----
@ -53,13 +53,13 @@ A face.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `face`| | No |
| `id` |`string` (`uuid`)| The id of the face. | No |
| `id` |`string`| The id of the face. | No |
| `value` |`string`| The tag of the face. | No |
| `xAxis` |`object`| What should the face’s X axis be? | No |
| `yAxis` |`object`| What should the face’s Y axis be? | No |
| `zAxis` |`object`| The z-axis (normal). | No |
| `solid` |`object`| The solid the face is on. | No |
| `__meta` |`array`| | No |
| `__meta` |`[` `object` `]`| | No |
----
@ -80,12 +80,12 @@ A sketch is a collection of paths.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `id` |`string` (`uuid`)| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`array`| The paths in the sketch. | No |
| `on` |`oneOf`| What the sketch is on (can be a plane or a face). | No |
| `id` |`string`| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The paths in the sketch. | No |
| `on` |**oneOf:** `object` **OR** `object`| What the sketch is on (can be a plane or a face). | No |
| `start` |`object`| The starting path. | No |
| `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
| `__meta` |`array`| Metadata. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |
----

8
docs/kcl/types/SketchSet.md
View File

@ -24,12 +24,12 @@ A sketch is a collection of paths.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `sketch`| | No |
| `id` |`string` (`uuid`)| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`array`| The paths in the sketch. | No |
| `on` |`oneOf`| What the sketch is on (can be a plane or a face). | No |
| `id` |`string`| The id of the sketch (this will change when the engine&#x27;s reference to it changes. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The paths in the sketch. | No |
| `on` |**oneOf:** `object` **OR** `object`| What the sketch is on (can be a plane or a face). | No |
| `start` |`object`| The starting path. | No |
| `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
| `__meta` |`array`| Metadata. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |
----

10
docs/kcl/types/SketchSurface.md
View File

@ -24,13 +24,13 @@ A plane.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `plane`| | No |
| `id` |`string` (`uuid`)| The id of the plane. | No |
| `value` |`oneOf`| Type for a plane. | No |
| `id` |`string`| The id of the plane. | No |
| `value` |**oneOf:** enum: `XY`, `XZ`, `YZ` **OR** enum: `Custom`| Type for a plane. | No |
| `origin` |`object`| Origin of the plane. | No |
| `xAxis` |`object`| What should the plane’s X axis be? | No |
| `yAxis` |`object`| What should the plane’s Y axis be? | No |
| `zAxis` |`object`| The z-axis (normal). | No |
| `__meta` |`array`| | No |
| `__meta` |`[` `object` `]`| | No |
----
@ -47,13 +47,13 @@ A face.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `face`| | No |
| `id` |`string` (`uuid`)| The id of the face. | No |
| `id` |`string`| The id of the face. | No |
| `value` |`string`| The tag of the face. | No |
| `xAxis` |`object`| What should the face’s X axis be? | No |
| `yAxis` |`object`| What should the face’s Y axis be? | No |
| `zAxis` |`object`| The z-axis (normal). | No |
| `solid` |`object`| The solid the face is on. | No |
| `__meta` |`array`| | No |
| `__meta` |`[` `object` `]`| | No |
----

14
docs/kcl/types/Solid.md
View File

@ -16,13 +16,13 @@ An solid is a collection of extrude surfaces.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `id` |`string` (`uuid`)| The id of the solid. | No |
| `value` |`array`| The extrude surfaces. | No |
| `id` |`string`| The id of the solid. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The extrude surfaces. | No |
| `sketch` |`object`| The sketch. | No |
| `height` |`number` (`double`)| The height of the solid. | No |
| `startCapId` |`string` (`uuid`)| The id of the extrusion start cap | No |
| `endCapId` |`string` (`uuid`)| The id of the extrusion end cap | No |
| `edgeCuts` |`array`| Chamfers or fillets on this solid. | No |
| `__meta` |`array`| Metadata. | No |
| `height` |`number`| The height of the solid. | No |
| `startCapId` |`string`| The id of the extrusion start cap | No |
| `endCapId` |`string`| The id of the extrusion end cap | No |
| `edgeCuts` |`[` **oneOf:** `object` **OR** `object` `]`| Chamfers or fillets on this solid. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |

14
docs/kcl/types/SolidSet.md
View File

@ -24,14 +24,14 @@ An solid is a collection of extrude surfaces.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `type` |enum: `solid`| | No |
| `id` |`string` (`uuid`)| The id of the solid. | No |
| `value` |`array`| The extrude surfaces. | No |
| `id` |`string`| The id of the solid. | No |
| `value` |`[` **oneOf:** `object` **OR** `object` **OR** `object` **OR** `object` `]`| The extrude surfaces. | No |
| `sketch` |`object`| The sketch. | No |
| `height` |`number` (`double`)| The height of the solid. | No |
| `startCapId` |`string` (`uuid`)| The id of the extrusion start cap | No |
| `endCapId` |`string` (`uuid`)| The id of the extrusion end cap | No |
| `edgeCuts` |`array`| Chamfers or fillets on this solid. | No |
| `__meta` |`array`| Metadata. | No |
| `height` |`number`| The height of the solid. | No |
| `startCapId` |`string`| The id of the extrusion start cap | No |
| `endCapId` |`string`| The id of the extrusion end cap | No |
| `edgeCuts` |`[` **oneOf:** `object` **OR** `object` `]`| Chamfers or fillets on this solid. | No |
| `__meta` |`[` `object` `]`| Metadata. | No |
----

4
docs/kcl/types/TangentialArcData.md
View File

@ -21,8 +21,8 @@ Data to draw a tangential arc.
| Property | Type | Description | Required |
|----------|------|-------------|----------|
| `radius` |`number` (`double`)| Radius of the arc. Not to be confused with Raiders of the Lost Ark. | No |
| `offset` |`number` (`double`)| Offset of the arc, in degrees. | No |
| `radius` |`number`| Radius of the arc. Not to be confused with Raiders of the Lost Ark. | No |
| `offset` |`number`| Offset of the arc, in degrees. | No |
----