kcl std lib docs use handlebars now so making changes should be better (1st pass) (#4007)
* updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * start of types docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * add types files Signed-off-by: Jess Frazelle <github@jessfraz.com> * add links Signed-off-by: Jess Frazelle <github@jessfraz.com> * better Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * uodates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
953
docs/kcl/arc.md
953
docs/kcl/arc.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1102
docs/kcl/circle.md
1102
docs/kcl/circle.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1368
docs/kcl/hole.md
1368
docs/kcl/hole.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -16,20 +16,23 @@ legAngX(hypotenuse: number, leg: number) -> number
|
||||
|
||||
* `utilities`
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `hypotenuse` | `number` | | Yes |
|
||||
| `leg` | `number` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```js
|
||||
legAngX(5, 3)
|
||||
```
|
||||
|
||||
### Arguments
|
||||
|
||||
* `hypotenuse`: `number` (REQUIRED)
|
||||
* `leg`: `number` (REQUIRED)
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
|
||||
|
||||
@ -16,20 +16,23 @@ legAngY(hypotenuse: number, leg: number) -> number
|
||||
|
||||
* `utilities`
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `hypotenuse` | `number` | | Yes |
|
||||
| `leg` | `number` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```js
|
||||
legAngY(5, 3)
|
||||
```
|
||||
|
||||
### Arguments
|
||||
|
||||
* `hypotenuse`: `number` (REQUIRED)
|
||||
* `leg`: `number` (REQUIRED)
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
|
||||
|
||||
@ -16,20 +16,23 @@ legLen(hypotenuse: number, leg: number) -> number
|
||||
|
||||
* `utilities`
|
||||
|
||||
|
||||
### Arguments
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `hypotenuse` | `number` | | Yes |
|
||||
| `leg` | `number` | | Yes |
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```js
|
||||
legLen(5, 3)
|
||||
```
|
||||
|
||||
### Arguments
|
||||
|
||||
* `hypotenuse`: `number` (REQUIRED)
|
||||
* `leg`: `number` (REQUIRED)
|
||||
|
||||
### Returns
|
||||
|
||||
`number`
|
||||
|
||||
|
||||
|
||||
|
||||
931
docs/kcl/line.md
931
docs/kcl/line.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
450
docs/kcl/loft.md
450
docs/kcl/loft.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1004
docs/kcl/revolve.md
1004
docs/kcl/revolve.md
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -164615,7 +164615,7 @@
|
||||
"args": [
|
||||
{
|
||||
"name": "data",
|
||||
"type": "MirrorData",
|
||||
"type": "Mirror2dData",
|
||||
"schema": {
|
||||
"description": "Data for a mirror.",
|
||||
"type": "object",
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
45
docs/kcl/types/AngledLineData.md
Normal file
45
docs/kcl/types/AngledLineData.md
Normal file
@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "AngledLineData"
|
||||
excerpt: "Data to draw an angled line."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data to draw an angled line.
|
||||
|
||||
|
||||
|
||||
**This schema accepts any of the following:**
|
||||
|
||||
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 |
|
||||
|
||||
|
||||
----
|
||||
An angle and length given as a pair
|
||||
|
||||
|
||||
**Type:** `array`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
----
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
23
docs/kcl/types/AngledLineThatIntersectsData.md
Normal file
23
docs/kcl/types/AngledLineThatIntersectsData.md
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: "AngledLineThatIntersectsData"
|
||||
excerpt: "Data for drawing an angled line that intersects with a given line."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data for drawing an angled line that intersects with a given line.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
22
docs/kcl/types/AngledLineToData.md
Normal file
22
docs/kcl/types/AngledLineToData.md
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "AngledLineToData"
|
||||
excerpt: "Data to draw an angled line to a point."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data to draw an angled line to a point.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `angle` |`number` (`double`)| The angle of the line. | No |
|
||||
| `to` |`number` (`double`)| The point to draw to. | No |
|
||||
|
||||
|
||||
53
docs/kcl/types/ArcData.md
Normal file
53
docs/kcl/types/ArcData.md
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
title: "ArcData"
|
||||
excerpt: "Data to draw an arc."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
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 |
|
||||
|----------|------|-------------|----------|
|
||||
| `angleEnd` |`number` (`double`)| The end angle. | No |
|
||||
| `angleStart` |`number` (`double`)| The start angle. | No |
|
||||
| `radius` |`number` (`double`)| The radius. | No |
|
||||
|
||||
|
||||
----
|
||||
Center, to and radius with an optional tag.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `center` |`array`| The center. | No |
|
||||
| `radius` |`number` (`double`)| The radius. | No |
|
||||
| `to` |`array`| The to point. | No |
|
||||
|
||||
|
||||
----
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
23
docs/kcl/types/BezierData.md
Normal file
23
docs/kcl/types/BezierData.md
Normal file
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: "BezierData"
|
||||
excerpt: "Data to draw a bezier curve."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data to draw a bezier curve.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `control1` |`array`| The first control point. | No |
|
||||
| `control2` |`array`| The second control point. | No |
|
||||
| `to` |`array`| The to point. | No |
|
||||
|
||||
|
||||
22
docs/kcl/types/ChamferData.md
Normal file
22
docs/kcl/types/ChamferData.md
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "ChamferData"
|
||||
excerpt: "Data for chamfers."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data for chamfers.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
22
docs/kcl/types/CircleData.md
Normal file
22
docs/kcl/types/CircleData.md
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
title: "CircleData"
|
||||
excerpt: "Data for drawing an circle"
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data for drawing an circle
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `center` |`array`| The center of the circle. | No |
|
||||
| `radius` |`number` (`double`)| The circle radius | No |
|
||||
|
||||
|
||||
24
docs/kcl/types/CircularPattern2dData.md
Normal file
24
docs/kcl/types/CircularPattern2dData.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "CircularPattern2dData"
|
||||
excerpt: "Data for a circular pattern on a 2D sketch."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data for a circular pattern on a 2D sketch.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
|
||||
| `center` |`array`| The center about which to make the pattern. This is a 2D vector. | No |
|
||||
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
|
||||
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
|
||||
|
||||
|
||||
25
docs/kcl/types/CircularPattern3dData.md
Normal file
25
docs/kcl/types/CircularPattern3dData.md
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: "CircularPattern3dData"
|
||||
excerpt: "Data for a circular pattern on a 3D model."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Data for a circular pattern on a 3D model.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | 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 |
|
||||
| `repetitions` |`integer` (`uint32`)| The number of repetitions. Must be greater than 0. This excludes the original entity. For example, if `repetitions` is 1, the original entity will be copied once. | No |
|
||||
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
|
||||
|
||||
|
||||
28
docs/kcl/types/ExtrudeGroup.md
Normal file
28
docs/kcl/types/ExtrudeGroup.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "ExtrudeGroup"
|
||||
excerpt: "An extrude group is a collection of extrude surfaces."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
An extrude group is a collection of extrude surfaces.
|
||||
|
||||
|
||||
**Type:** `object`
|
||||
|
||||
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description | Required |
|
||||
|----------|------|-------------|----------|
|
||||
| `__meta` |`array`| Metadata. | No |
|
||||
| `edgeCuts` |`array`| Chamfers or fillets on this extrude group. | No |
|
||||
| `endCapId` |`string` (`uuid`)| The id of the extrusion end cap | No |
|
||||
| `height` |`number` (`double`)| The height of the extrude group. | No |
|
||||
| `id` |`string` (`uuid`)| The id of the extrude group. | No |
|
||||
| `sketchGroup` |`object`| The sketch group. | No |
|
||||
| `startCapId` |`string` (`uuid`)| The id of the extrusion start cap | No |
|
||||
| `value` |`array`| The extrude surfaces. | No |
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user