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

one more pass of docs (#4026)

Browse Source
This commit is contained in:
Jess Frazelle
2024-09-27 23:03:48 -07:00
committed by GitHub
parent 790af3842c
commit 2a35dd2398
35 changed files with 161 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,10 +8,15 @@ Data to draw an angled line.
**This schema accepts any of the following:**
An angle and length with explicitly named parameters
[`PolarCoordsData`](/docs/kcl/types/PolarCoordsData)
@ -23,8 +28,10 @@ An angle and length with explicitly named parameters
An angle and length given as a pair
**Type:** `array`
`[number, number]`

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

@ -7,11 +7,13 @@ layout: manual
Data for drawing an angled line that intersects with a given line.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data to draw an angled line to a point.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -8,16 +8,20 @@ Data to draw an arc.
**This schema accepts any of the following:**
Angles and radius with an optional tag.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -31,11 +35,13 @@ Angles and radius with an optional tag.
Center, to and radius with an optional tag.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data to draw a bezier curve.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for chamfers.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for drawing an circle
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a circular pattern on a 2D sketch.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a circular pattern on a 3D model.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -8,17 +8,22 @@ A tag for a face.
**This schema accepts any of the following:**
**This schema accepts exactly one of the following:**
The start face as in before you extruded. This could also be known as the bottom face. But we do not call it bottom because it would be the top face if you extruded it in the opposite direction or flipped the camera.
**enum:** `start`
@ -26,10 +31,12 @@ The start face as in before you extruded. This could also be known as the bottom
----
The end face after you extruded. This could also be known as the top face. But we do not call it top because it would be the bottom face if you extruded it in the opposite direction or flipped the camera.
**enum:** `end`
@ -37,6 +44,7 @@ The end face after you extruded. This could also be known as the top face. But w
----
@ -45,6 +53,9 @@ The end face after you extruded. This could also be known as the top face. But w
----
A tag for the face.
[`TagIdentifier`](/docs/kcl/types#tag-identifier)

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

@ -7,11 +7,13 @@ layout: manual
Data for fillets.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for helices.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -9,16 +9,20 @@ Import format specifier
**This schema accepts exactly one of the following:**
Autodesk Filmbox (FBX) format
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -30,11 +34,13 @@ Autodesk Filmbox (FBX) format
Binary glTF 2.0. We refer to this as glTF since that is how our customers refer to it, but this can also import binary glTF (glb).
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -46,11 +52,13 @@ Binary glTF 2.0. We refer to this as glTF since that is how our customers refer
Wavefront OBJ format.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -64,11 +72,13 @@ Wavefront OBJ format.
The PLY Polygon File Format.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -82,11 +92,13 @@ The PLY Polygon File Format.
SolidWorks part (SLDPRT) format.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -98,11 +110,13 @@ SolidWorks part (SLDPRT) format.
ISO 10303-21 (STEP) format.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -114,11 +128,13 @@ ISO 10303-21 (STEP) format.
ST**ereo**L**ithography format.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for an imported geometry.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a linear pattern on a 2D sketch.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a linear pattern on a 3D model.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a loft.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for a mirror.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

16
docs/kcl/types/PlaneData.md
View File

@ -9,11 +9,14 @@ Data for a plane.
**This schema accepts exactly one of the following:**
The XY plane.
**enum:** `XY`
@ -21,10 +24,12 @@ The XY plane.
----
The opposite side of the XY plane.
**enum:** `-XY`
@ -32,10 +37,12 @@ The opposite side of the XY plane.
----
The XZ plane.
**enum:** `XZ`
@ -43,10 +50,12 @@ The XZ plane.
----
The opposite side of the XZ plane.
**enum:** `-XZ`
@ -54,10 +63,12 @@ The opposite side of the XZ plane.
----
The YZ plane.
**enum:** `YZ`
@ -65,10 +76,12 @@ The YZ plane.
----
The opposite side of the YZ plane.
**enum:** `-YZ`
@ -76,15 +89,18 @@ The opposite side of the YZ plane.
----
A defined plane.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for polar coordinates.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for revolution surfaces.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
Data for shells.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
A sketch is a collection of paths.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -8,10 +8,15 @@ Data for start sketch on. You can start a sketch on a plane or an solid.
**This schema accepts any of the following:**
Data for a plane.
[`PlaneData`](/docs/kcl/types/PlaneData)
@ -23,11 +28,13 @@ Data for a plane.
An solid is a collection of extrude surfaces.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -8,6 +8,8 @@ A sketch surface or a sketch.
**This schema accepts any of the following:**
A sketch type.
@ -15,16 +17,20 @@ A sketch type.
**This schema accepts exactly one of the following:**
A plane.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -43,11 +49,13 @@ A plane.
A face.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -71,11 +79,13 @@ A face.
A sketch is a collection of paths.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -9,16 +9,20 @@ A sketch or a group of sketches.
**This schema accepts exactly one of the following:**
A sketch is a collection of paths.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -35,8 +39,10 @@ A sketch is a collection of paths.
----
**Type:** `[object, array]`
`[` `object` `]`

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

@ -9,16 +9,20 @@ A sketch type.
**This schema accepts exactly one of the following:**
A plane.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -37,11 +41,13 @@ A plane.
A face.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -7,11 +7,13 @@ layout: manual
An solid is a collection of extrude surfaces.
**Type:** `object`
## Properties
| Property | Type | Description | Required |

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

@ -9,16 +9,20 @@ A solid or a group of solids.
**This schema accepts exactly one of the following:**
An solid is a collection of extrude surfaces.
**Type:** `object`
## Properties
| Property | Type | Description | Required |
@ -37,8 +41,10 @@ An solid is a collection of extrude surfaces.
----
**Type:** `[object, array]`
`[` `object` `]`

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

@ -9,11 +9,14 @@ One of the standard planes.
**This schema accepts exactly one of the following:**
The XY plane.
**enum:** `XY`
@ -21,10 +24,12 @@ The XY plane.
----
The opposite side of the XY plane.
**enum:** `-XY`
@ -32,10 +37,12 @@ The opposite side of the XY plane.
----
The XZ plane.
**enum:** `XZ`
@ -43,10 +50,12 @@ The XZ plane.
----
The opposite side of the XZ plane.
**enum:** `-XZ`
@ -54,10 +63,12 @@ The opposite side of the XZ plane.
----
The YZ plane.
**enum:** `YZ`
@ -65,10 +76,12 @@ The YZ plane.
----
The opposite side of the YZ plane.
**enum:** `-YZ`
@ -76,6 +89,7 @@ The opposite side of the YZ plane.
----

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

@ -8,15 +8,19 @@ Data to draw a tangential arc.
**This schema accepts any of the following:**
**Type:** `object`
## Properties
| Property | Type | Description | Required |