Compare commits
16 Commits
jtran/exec
...
v0.25.5
Author | SHA1 | Date | |
---|---|---|---|
6dfadbea18 | |||
0d48dff151 | |||
f74b436e3d | |||
bb3f9e0377 | |||
02be831c67 | |||
2e72f235dd | |||
3949b6acf4 | |||
168f4fc545 | |||
85541c76f5 | |||
7ed29e2ce4 | |||
2a35dd2398 | |||
790af3842c | |||
37bb696a30 | |||
e50de134b1 | |||
9a437ca973 | |||
30bcf21912 |
@ -1,2 +1,3 @@
|
|||||||
src/wasm-lib/*
|
src/wasm-lib/*
|
||||||
*.typegen.ts
|
*.typegen.ts
|
||||||
|
packages/codemirror-lsp-client/dist/*
|
||||||
|
2
.github/workflows/generate-website-docs.yml
vendored
2
.github/workflows/generate-website-docs.yml
vendored
@ -38,8 +38,10 @@ jobs:
|
|||||||
mkdir -p documentation/content/pages/docs/kcl/
|
mkdir -p documentation/content/pages/docs/kcl/
|
||||||
# cleanup old
|
# cleanup old
|
||||||
rm -rf documentation/content/pages/docs/kcl/*.md
|
rm -rf documentation/content/pages/docs/kcl/*.md
|
||||||
|
rm -rf documentation/content/pages/docs/kcl/types
|
||||||
# move new
|
# move new
|
||||||
mv -f docs/kcl/*.md documentation/content/pages/docs/kcl/
|
mv -f docs/kcl/*.md documentation/content/pages/docs/kcl/
|
||||||
|
mv -f docs/kcl/types documentation/content/pages/docs/kcl/
|
||||||
- name: commit the changes in the docs repo
|
- name: commit the changes in the docs repo
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
|
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
@ -6,10 +6,10 @@ layout: manual
|
|||||||
|
|
||||||
Create a line segment from the current 2-dimensional sketch origin
|
Create a line segment from the current 2-dimensional sketch origin
|
||||||
|
|
||||||
along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
|
along some angle (in degrees) for some length, ending at the provided value in the 'x' dimension.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
angledLineToX(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
|
angledLineToX(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,13 +17,13 @@ angledLineToX(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
|
| `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No |
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
@ -6,10 +6,10 @@ layout: manual
|
|||||||
|
|
||||||
Create a line segment from the current 2-dimensional sketch origin
|
Create a line segment from the current 2-dimensional sketch origin
|
||||||
|
|
||||||
along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
|
along some angle (in degrees) for some length, ending at the provided value in the 'y' dimension.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
angledLineToY(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
|
angledLineToY(data: AngledLineToData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,13 +17,13 @@ angledLineToY(data: AngledLineToData, sketch_group: SketchGroup, tag?: TagDeclar
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `data` | [`AngledLineToData`](kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
|
| `data` | [`AngledLineToData`](/docs/kcl/types/AngledLineToData) | Data to draw an angled line to a point. | Yes |
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No |
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
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
@ -6,10 +6,10 @@ layout: manual
|
|||||||
|
|
||||||
Draw a smooth, continuous, curved line segment from the current origin to
|
Draw a smooth, continuous, curved line segment from the current origin to
|
||||||
|
|
||||||
the desired (x, y), using a number of control points to shape the curve's shape.
|
the desired (x, y), using a number of control points to shape the curve's shape.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
bezierCurve(data: BezierData, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
|
bezierCurve(data: BezierData, sketch: Sketch, tag?: TagDeclarator) -> Sketch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,13 +17,13 @@ bezierCurve(data: BezierData, sketch_group: SketchGroup, tag?: TagDeclarator) ->
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `data` | [`BezierData`](kcl/types/BezierData) | Data to draw a bezier curve. | Yes |
|
| `data` | [`BezierData`](/docs/kcl/types/BezierData) | Data to draw a bezier curve. | Yes |
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No |
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
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
@ -7,9 +7,12 @@ layout: manual
|
|||||||
Centimeters conversion factor for current projects units.
|
Centimeters conversion factor for current projects units.
|
||||||
|
|
||||||
No matter what units the current project uses, this function will always return the conversion factor to centimeters.
|
No matter what units the current project uses, this function will always return the conversion factor to centimeters.
|
||||||
For example, if the current project uses inches, this function will return `0.393701`. If the current project uses millimeters, this function will return `10`. If the current project uses centimeters, this function will return `1`.
|
|
||||||
|
For example, if the current project uses inches, this function will return `0.393701`. If the current project uses millimeters, this function will return `10`. If the current project uses centimeters, this function will return `1`.
|
||||||
|
|
||||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
||||||
We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
|
|
||||||
|
We merely provide these functions for convenience and readability, as `10 * cm()` is more readable that your intent is "I want 10 centimeters" than `10 * 10`, if the project settings are in millimeters.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
cm() -> number
|
cm() -> number
|
||||||
|
File diff suppressed because one or more lines are too long
@ -9,7 +9,7 @@ Extend a 2-dimensional sketch through a third dimension in order to
|
|||||||
create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
|
create new 3-dimensional volume, or if extruded into an existing volume, cut into an existing solid.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
extrude(length: number, sketch_group_set: SketchGroupSet) -> ExtrudeGroupSet
|
extrude(length: number, sketch_set: SketchSet) -> SolidSet
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -18,11 +18,11 @@ extrude(length: number, sketch_group_set: SketchGroupSet) -> ExtrudeGroupSet
|
|||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `length` | `number` | | Yes |
|
| `length` | `number` | | Yes |
|
||||||
| `sketch_group_set` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
|
| `sketch_set` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`ExtrudeGroupSet`](kcl/types/ExtrudeGroupSet) - A extrude group or a group of extrude groups.
|
[`SolidSet`](/docs/kcl/types/SolidSet) - A solid or a group of solids.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -7,9 +7,12 @@ layout: manual
|
|||||||
Feet conversion factor for current projects units.
|
Feet conversion factor for current projects units.
|
||||||
|
|
||||||
No matter what units the current project uses, this function will always return the conversion factor to feet.
|
No matter what units the current project uses, this function will always return the conversion factor to feet.
|
||||||
For example, if the current project uses inches, this function will return `12`. If the current project uses millimeters, this function will return `304.8`. If the current project uses feet, this function will return `1`.
|
|
||||||
|
For example, if the current project uses inches, this function will return `12`. If the current project uses millimeters, this function will return `304.8`. If the current project uses feet, this function will return `1`.
|
||||||
|
|
||||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
||||||
We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
|
|
||||||
|
We merely provide these functions for convenience and readability, as `10 * ft()` is more readable that your intent is "I want 10 feet" than `10 * 304.8`, if the project settings are in millimeters.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
ft() -> number
|
ft() -> number
|
||||||
|
@ -17,7 +17,7 @@ getNextAdjacentEdge(tag: TagIdentifier) -> Uuid
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes |
|
| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
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
@ -9,7 +9,7 @@ Use a 2-dimensional sketch to cut a hole in another 2-dimensional sketch.
|
|||||||
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
hole(hole_sketch_group: SketchGroupSet, sketch_group: SketchGroup) -> SketchGroup
|
hole(hole_sketch: SketchSet, sketch: Sketch) -> Sketch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,12 +17,12 @@ hole(hole_sketch_group: SketchGroupSet, sketch_group: SketchGroup) -> SketchGrou
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `hole_sketch_group` | [`SketchGroupSet`](kcl/types/SketchGroupSet) | A sketch group or a group of sketch groups. | Yes |
|
| `hole_sketch` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -7,9 +7,12 @@ layout: manual
|
|||||||
Inches conversion factor for current projects units.
|
Inches conversion factor for current projects units.
|
||||||
|
|
||||||
No matter what units the current project uses, this function will always return the conversion factor to inches.
|
No matter what units the current project uses, this function will always return the conversion factor to inches.
|
||||||
For example, if the current project uses inches, this function will return `1`. If the current project uses millimeters, this function will return `25.4`.
|
|
||||||
|
For example, if the current project uses inches, this function will return `1`. If the current project uses millimeters, this function will return `25.4`.
|
||||||
|
|
||||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
||||||
We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
|
|
||||||
|
We merely provide these functions for convenience and readability, as `10 * inch()` is more readable that your intent is "I want 10 inches" than `10 * 25.4`, if the project settings are in millimeters.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
inch() -> number
|
inch() -> number
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,15 +1,15 @@
|
|||||||
---
|
---
|
||||||
title: "lastSegY"
|
title: "lastSegY"
|
||||||
excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d"
|
excerpt: "Extract the 'y' axis value of the last line segment in the provided 2-d"
|
||||||
layout: manual
|
layout: manual
|
||||||
---
|
---
|
||||||
|
|
||||||
Extract the 'y' axis value of the last line segment in the provided 2-d
|
Extract the 'y' axis value of the last line segment in the provided 2-d
|
||||||
|
|
||||||
sketch.
|
sketch.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
lastSegY(sketch_group: SketchGroup) -> number
|
lastSegY(sketch: Sketch) -> number
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,7 +17,7 @@ lastSegY(sketch_group: SketchGroup) -> number
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -9,7 +9,7 @@ Draw a line from the current origin to some absolute (x, y) point.
|
|||||||
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
lineTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
|
lineTo(to: [number], sketch: Sketch, tag?: TagDeclarator) -> Sketch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,13 +17,13 @@ lineTo(to: [number], sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGr
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `to` | [`[number]`](kcl/types/[number]) | | Yes |
|
| `to` | `[number]` | | Yes |
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No |
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
[`Sketch`](/docs/kcl/types/Sketch) - A sketch is a collection of paths.
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
File diff suppressed because one or more lines are too long
@ -6,7 +6,7 @@ layout: manual
|
|||||||
|
|
||||||
Compute the logarithm of the number with respect to an arbitrary base.
|
Compute the logarithm of the number with respect to an arbitrary base.
|
||||||
|
|
||||||
The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
|
The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
log(num: number, base: number) -> number
|
log(num: number, base: number) -> number
|
||||||
|
@ -7,9 +7,12 @@ layout: manual
|
|||||||
Meters conversion factor for current projects units.
|
Meters conversion factor for current projects units.
|
||||||
|
|
||||||
No matter what units the current project uses, this function will always return the conversion factor to meters.
|
No matter what units the current project uses, this function will always return the conversion factor to meters.
|
||||||
For example, if the current project uses inches, this function will return `39.3701`. If the current project uses millimeters, this function will return `1000`. If the current project uses meters, this function will return `1`.
|
|
||||||
|
For example, if the current project uses inches, this function will return `39.3701`. If the current project uses millimeters, this function will return `1000`. If the current project uses meters, this function will return `1`.
|
||||||
|
|
||||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
||||||
We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
|
|
||||||
|
We merely provide these functions for convenience and readability, as `10 * m()` is more readable that your intent is "I want 10 meters" than `10 * 1000`, if the project settings are in millimeters.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
m() -> number
|
m() -> number
|
||||||
|
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
@ -7,9 +7,12 @@ layout: manual
|
|||||||
Millimeters conversion factor for current projects units.
|
Millimeters conversion factor for current projects units.
|
||||||
|
|
||||||
No matter what units the current project uses, this function will always return the conversion factor to millimeters.
|
No matter what units the current project uses, this function will always return the conversion factor to millimeters.
|
||||||
For example, if the current project uses inches, this function will return `(1/25.4)`. If the current project uses millimeters, this function will return `1`.
|
|
||||||
|
For example, if the current project uses inches, this function will return `(1/25.4)`. If the current project uses millimeters, this function will return `1`.
|
||||||
|
|
||||||
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
**Caution**: This function is only intended to be used when you absolutely MUST have different units in your code than the project settings. Otherwise, it is a bad pattern to use this function.
|
||||||
We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
|
|
||||||
|
We merely provide these functions for convenience and readability, as `10 * mm()` is more readable that your intent is "I want 10 millimeters" than `10 * (1/25.4)`, if the project settings are in inches.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
mm() -> number
|
mm() -> number
|
||||||
|
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
@ -17,11 +17,11 @@ polar(data: PolarCoordsData) -> [number]
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `data` | [`PolarCoordsData`](kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes |
|
| `data` | [`PolarCoordsData`](/docs/kcl/types/PolarCoordsData) | Data for polar coordinates. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`[number]`](kcl/types/[number])
|
`[number]`
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
@ -1,15 +1,15 @@
|
|||||||
---
|
---
|
||||||
title: "profileStart"
|
title: "profileStart"
|
||||||
excerpt: "Extract the provided 2-dimensional sketch group's profile's origin"
|
excerpt: "Extract the provided 2-dimensional sketch's profile's origin"
|
||||||
layout: manual
|
layout: manual
|
||||||
---
|
---
|
||||||
|
|
||||||
Extract the provided 2-dimensional sketch group's profile's origin
|
Extract the provided 2-dimensional sketch's profile's origin
|
||||||
|
|
||||||
value.
|
value.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
profileStart(sketch_group: SketchGroup) -> [number]
|
profileStart(sketch: Sketch) -> [number]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,11 +17,11 @@ profileStart(sketch_group: SketchGroup) -> [number]
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
[`[number]`](kcl/types/[number])
|
`[number]`
|
||||||
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,15 +1,15 @@
|
|||||||
---
|
---
|
||||||
title: "profileStartY"
|
title: "profileStartY"
|
||||||
excerpt: "Extract the provided 2-dimensional sketch group's profile's origin's 'y'"
|
excerpt: "Extract the provided 2-dimensional sketch's profile's origin's 'y'"
|
||||||
layout: manual
|
layout: manual
|
||||||
---
|
---
|
||||||
|
|
||||||
Extract the provided 2-dimensional sketch group's profile's origin's 'y'
|
Extract the provided 2-dimensional sketch's profile's origin's 'y'
|
||||||
|
|
||||||
value.
|
value.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
profileStartY(sketch_group: SketchGroup) -> number
|
profileStartY(sketch: Sketch) -> number
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@ -17,7 +17,7 @@ profileStartY(sketch_group: SketchGroup) -> number
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | A sketch is a collection of paths. | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
---
|
---
|
||||||
title: "rem"
|
title: "rem"
|
||||||
excerpt: "Compute the remainder after dividing `num` by `div`."
|
excerpt: "Compute the remainder after dividing `num` by `div`."
|
||||||
layout: manual
|
layout: manual
|
||||||
---
|
---
|
||||||
|
|
||||||
Compute the remainder after dividing `num` by `div`.
|
Compute the remainder after dividing `num` by `div`.
|
||||||
|
|
||||||
If `num` is negative, the result will be too.
|
If `num` is negative, the result will be too.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
rem(num: i64, divisor: i64) -> i64
|
rem(num: i64, divisor: i64) -> i64
|
||||||
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "segEndX"
|
title: "segEndX"
|
||||||
excerpt: "Compute the ending point of the provided line segment along the 'x' axis."
|
excerpt: "Compute the ending point of the provided line segment along the 'x' axis."
|
||||||
layout: manual
|
layout: manual
|
||||||
---
|
---
|
||||||
|
|
||||||
Compute the ending point of the provided line segment along the 'x' axis.
|
Compute the ending point of the provided line segment along the 'x' axis.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -17,7 +17,7 @@ segEndX(tag: TagIdentifier) -> number
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes |
|
| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
@ -17,7 +17,7 @@ segLen(tag: TagIdentifier) -> number
|
|||||||
|
|
||||||
| Name | Type | Description | Required |
|
| Name | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `tag` | [`TagIdentifier`](kcl/types#tag-identifier) | | Yes |
|
| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | | Yes |
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
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
427226
docs/kcl/std.json
427226
docs/kcl/std.json
File diff suppressed because it is too large
Load Diff
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
@ -8,30 +8,26 @@ Data to draw an angled line.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**This schema accepts any of the following:**
|
**This schema accepts any of the following:**
|
||||||
|
|
||||||
An angle and length with explicitly named parameters
|
An angle and length with explicitly named parameters
|
||||||
|
|
||||||
|
[`PolarCoordsData`](/docs/kcl/types/PolarCoordsData)
|
||||||
**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
|
An angle and length given as a pair
|
||||||
|
|
||||||
|
|
||||||
**Type:** `array`
|
**Type:** `array`
|
||||||
|
|
||||||
|
`[number, number]`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,18 +6,18 @@ layout: manual
|
|||||||
|
|
||||||
Data for drawing an angled line that intersects with a given line.
|
Data for drawing an angled line that intersects with a given line.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `angle` |`number` (`double`)| The angle of the line. | No |
|
| `angle` |`number`| The angle of the line. | No |
|
||||||
| `intersectTag` |`object`| The tag of the line to intersect with. | No |
|
| `intersectTag` |[`TagIdentifier`](/docs/kcl/types#tag-identifier)| The tag of the line to intersect with. | No |
|
||||||
| `offset` |`number` (`double`)| The offset from the intersecting line. | No |
|
| `offset` |`number`| The offset from the intersecting line. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,17 +6,17 @@ layout: manual
|
|||||||
|
|
||||||
Data to draw an angled line to a point.
|
Data to draw an angled line to a point.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `angle` |`number` (`double`)| The angle of the line. | No |
|
| `angle` |`number`| The angle of the line. | No |
|
||||||
| `to` |`number` (`double`)| The point to draw to. | No |
|
| `to` |`number`| The point to draw to. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,41 +8,42 @@ Data to draw an arc.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**This schema accepts any of the following:**
|
**This schema accepts any of the following:**
|
||||||
|
|
||||||
Angles and radius with an optional tag.
|
Angles and radius with an optional tag.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `angleEnd` |`number` (`double`)| The end angle. | No |
|
| `angleStart` |`number` (**maximum:** 360.0) (**minimum:** -360.0)| The start angle. | No |
|
||||||
| `angleStart` |`number` (`double`)| The start angle. | No |
|
| `angleEnd` |`number` (**maximum:** 360.0) (**minimum:** -360.0)| The end angle. | No |
|
||||||
| `radius` |`number` (`double`)| The radius. | No |
|
| `radius` |`number`| The radius. | No |
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
Center, to and radius with an optional tag.
|
Center, to and radius with an optional tag.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `center` |`array`| The center. | No |
|
| `center` |`[number, number]`| The center. | No |
|
||||||
| `radius` |`number` (`double`)| The radius. | No |
|
| `to` |`[number, number]`| The to point. | No |
|
||||||
| `to` |`array`| The to point. | No |
|
| `radius` |`number`| The radius. | No |
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
46
docs/kcl/types/Axis.md
Normal file
46
docs/kcl/types/Axis.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
---
|
||||||
|
title: "Axis"
|
||||||
|
excerpt: "Co-ordinate axis specifier."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
Co-ordinate axis specifier.
|
||||||
|
|
||||||
|
See [cglearn.eu] for background reading.
|
||||||
|
|
||||||
|
[cglearn.eu]: https://cglearn.eu/pub/computer-graphics/introduction-to-geometry#material-coordinate-systems-1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
|
'Y' axis.
|
||||||
|
|
||||||
|
**enum:** `y`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
'Z' axis.
|
||||||
|
|
||||||
|
**enum:** `z`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
81
docs/kcl/types/AxisAndOrigin.md
Normal file
81
docs/kcl/types/AxisAndOrigin.md
Normal file
@ -0,0 +1,81 @@
|
|||||||
|
---
|
||||||
|
title: "AxisAndOrigin"
|
||||||
|
excerpt: "Axis and origin."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
Axis and origin.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
|
X-axis.
|
||||||
|
|
||||||
|
**enum:** `X`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Y-axis.
|
||||||
|
|
||||||
|
**enum:** `Y`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Flip the X-axis.
|
||||||
|
|
||||||
|
**enum:** `-X`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Flip the Y-axis.
|
||||||
|
|
||||||
|
**enum:** `-Y`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `custom` |`object`| | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
22
docs/kcl/types/AxisDirectionPair.md
Normal file
22
docs/kcl/types/AxisDirectionPair.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: "AxisDirectionPair"
|
||||||
|
excerpt: "An [[`Axis`](/docs/kcl/types/Axis)] paired with a [[`Direction`](/docs/kcl/types/Direction)]."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
An [[`Axis`](/docs/kcl/types/Axis)] paired with a [[`Direction`](/docs/kcl/types/Direction)].
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `axis` |[`Axis`](/docs/kcl/types/Axis)| Axis specifier. | No |
|
||||||
|
| `direction` |[`Direction`](/docs/kcl/types/Direction)| Specifies which direction the axis is pointing. | No |
|
||||||
|
|
||||||
|
|
42
docs/kcl/types/AxisOrEdgeReference.md
Normal file
42
docs/kcl/types/AxisOrEdgeReference.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
title: "AxisOrEdgeReference"
|
||||||
|
excerpt: "Axis or tagged edge."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
Axis or tagged edge.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts any of the following:**
|
||||||
|
|
||||||
|
Axis and origin.
|
||||||
|
|
||||||
|
[`AxisAndOrigin`](/docs/kcl/types/AxisAndOrigin)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Tagged edge.
|
||||||
|
|
||||||
|
[`EdgeReference`](/docs/kcl/types/EdgeReference)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
24
docs/kcl/types/BasePath.md
Normal file
24
docs/kcl/types/BasePath.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
title: "BasePath"
|
||||||
|
excerpt: "A base path."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
A base path.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `from` |`[number, number]`| The from point. | No |
|
||||||
|
| `to` |`[number, number]`| The to point. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag of the path. | No |
|
||||||
|
| `__geoMeta` |[`GeoMeta`](/docs/kcl/types/GeoMeta)| Metadata. | No |
|
||||||
|
|
||||||
|
|
@ -6,18 +6,18 @@ layout: manual
|
|||||||
|
|
||||||
Data to draw a bezier curve.
|
Data to draw a bezier curve.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `control1` |`array`| The first control point. | No |
|
| `to` |`[number, number]`| The to point. | No |
|
||||||
| `control2` |`array`| The second control point. | No |
|
| `control1` |`[number, number]`| The first control point. | No |
|
||||||
| `to` |`array`| The to point. | No |
|
| `control2` |`[number, number]`| The second control point. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,17 +6,17 @@ layout: manual
|
|||||||
|
|
||||||
Data for chamfers.
|
Data for chamfers.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `length` |`number` (`double`)| The length of the chamfer. | No |
|
| `length` |`number`| The length of the chamfer. | No |
|
||||||
| `tags` |`array`| The tags of the paths you want to chamfer. | No |
|
| `tags` |`[` [`EdgeReference`](/docs/kcl/types/EdgeReference) `]`| The tags of the paths you want to chamfer. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,17 +6,17 @@ layout: manual
|
|||||||
|
|
||||||
Data for drawing an circle
|
Data for drawing an circle
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `center` |`array`| The center of the circle. | No |
|
| `center` |`[number, number]`| The center of the circle. | No |
|
||||||
| `radius` |`number` (`double`)| The circle radius | No |
|
| `radius` |`number`| The circle radius | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,19 +6,19 @@ layout: manual
|
|||||||
|
|
||||||
Data for a circular pattern on a 2D sketch.
|
Data for a circular pattern on a 2D sketch.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
|
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| 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 |
|
||||||
| `center` |`array`| The center about which to make the pattern. This is a 2D vector. | No |
|
| `center` |`[number, number]`| 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 |
|
| `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 |
|
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -6,20 +6,20 @@ layout: manual
|
|||||||
|
|
||||||
Data for a circular pattern on a 3D model.
|
Data for a circular pattern on a 3D model.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `arcDegrees` |`number` (`double`)| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
|
| `repetitions` |[`Uint`](/docs/kcl/types/Uint)| 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 |
|
||||||
| `axis` |`array`| The axis around which to make the pattern. This is a 3D vector. | No |
|
| `axis` |`[number, number, number]`| 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 |
|
| `center` |`[number, number, number]`| 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 |
|
| `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 |
|
| `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
|
||||||
|
|
||||||
|
|
||||||
|
42
docs/kcl/types/Direction.md
Normal file
42
docs/kcl/types/Direction.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
title: "Direction"
|
||||||
|
excerpt: "Specifies the sign of a co-ordinate axis."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
Specifies the sign of a co-ordinate axis.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
|
Increasing numbers.
|
||||||
|
|
||||||
|
**enum:** `positive`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Decreasing numbers.
|
||||||
|
|
||||||
|
**enum:** `negative`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
58
docs/kcl/types/EdgeCut.md
Normal file
58
docs/kcl/types/EdgeCut.md
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
---
|
||||||
|
title: "EdgeCut"
|
||||||
|
excerpt: "A fillet or a chamfer."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
A fillet or a chamfer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
|
A fillet.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `fillet`| | No |
|
||||||
|
| `id` |`string`| The id of the engine command that called this fillet. | No |
|
||||||
|
| `radius` |`number`| | No |
|
||||||
|
| `edgeId` |`string`| The engine id of the edge to fillet. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
A chamfer.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `chamfer`| | No |
|
||||||
|
| `id` |`string`| The id of the engine command that called this chamfer. | No |
|
||||||
|
| `length` |`number`| | No |
|
||||||
|
| `edgeId` |`string`| The engine id of the edge to chamfer. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
41
docs/kcl/types/EdgeReference.md
Normal file
41
docs/kcl/types/EdgeReference.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
---
|
||||||
|
title: "EdgeReference"
|
||||||
|
excerpt: "A tag or a uuid of an edge."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
A tag or a uuid of an edge.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts any of the following:**
|
||||||
|
|
||||||
|
A uuid of an edge.
|
||||||
|
|
||||||
|
**Type:** `string` (`uuid`)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
A tag of an edge.
|
||||||
|
|
||||||
|
[`TagIdentifier`](/docs/kcl/types#tag-identifier)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
|||||||
---
|
|
||||||
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 |
|
|
||||||
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
|||||||
---
|
|
||||||
title: "ExtrudeGroupSet"
|
|
||||||
excerpt: "A extrude group or a group of extrude groups."
|
|
||||||
layout: manual
|
|
||||||
---
|
|
||||||
|
|
||||||
A extrude group or a group of extrude groups.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**This schema accepts exactly one of the following:**
|
|
||||||
|
|
||||||
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 |
|
|
||||||
| `type` |enum: `extrudeGroup`
|
|
||||||
| | No |
|
|
||||||
| `value` |`array`| The extrude surfaces. | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
|
|
||||||
**Type:** `[object, array]`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
|
||||||
|----------|------|-------------|----------|
|
|
||||||
| `type` |enum: `extrudeGroups`
|
|
||||||
| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
98
docs/kcl/types/ExtrudeSurface.md
Normal file
98
docs/kcl/types/ExtrudeSurface.md
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
title: "ExtrudeSurface"
|
||||||
|
excerpt: "An extrude surface."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
An extrude surface.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
|
An extrude plane.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `extrudePlane`| | No |
|
||||||
|
| `faceId` |`string`| The face id for the extrude plane. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
|
||||||
|
| `id` |`string`| The id of the geometry. | No |
|
||||||
|
| `sourceRange` |`SourceRange`| The source range. | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
An extruded arc.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `extrudeArc`| | No |
|
||||||
|
| `faceId` |`string`| The face id for the extrude plane. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
|
||||||
|
| `id` |`string`| The id of the geometry. | No |
|
||||||
|
| `sourceRange` |`SourceRange`| The source range. | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Geometry metadata.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `chamfer`| | No |
|
||||||
|
| `faceId` |`string`| The id for the chamfer surface. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
|
||||||
|
| `id` |`string`| The id of the geometry. | No |
|
||||||
|
| `sourceRange` |`SourceRange`| The source range. | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
Geometry metadata.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `type` |enum: `fillet`| | No |
|
||||||
|
| `faceId` |`string`| The id for the fillet surface. | No |
|
||||||
|
| `tag` |[`TagDeclarator`](/docs/kcl/types#tag-declaration)| The tag. | No |
|
||||||
|
| `id` |`string`| The id of the geometry. | No |
|
||||||
|
| `sourceRange` |`SourceRange`| The source range. | No |
|
||||||
|
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -8,36 +8,16 @@ A tag for a face.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**This schema accepts any of the following:**
|
**This schema accepts any of the following:**
|
||||||
|
|
||||||
|
A tag for a face.
|
||||||
|
|
||||||
|
[`StartOrEnd`](/docs/kcl/types/StartOrEnd)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**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`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
----
|
|
||||||
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`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
----
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -45,19 +25,13 @@ The end face after you extruded. This could also be known as the top face. But w
|
|||||||
----
|
----
|
||||||
A tag for the face.
|
A tag for the face.
|
||||||
|
|
||||||
|
[`TagIdentifier`](/docs/kcl/types#tag-identifier)
|
||||||
**Type:** `object`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
|
||||||
|----------|------|-------------|----------|
|
|
||||||
| `__meta` |`array`| | No |
|
|
||||||
| `info` |`object`| Engine information for a tag. | No |
|
|
||||||
| `value` |`string`| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
@ -6,18 +6,18 @@ layout: manual
|
|||||||
|
|
||||||
Data for fillets.
|
Data for fillets.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `radius` |`number` (`double`)| The radius of the fillet. | No |
|
| `radius` |`number`| The radius of the fillet. | No |
|
||||||
| `tags` |`array`| The tags of the paths you want to fillet. | No |
|
| `tags` |`[` [`EdgeReference`](/docs/kcl/types/EdgeReference) `]`| The tags of the paths you want to fillet. | No |
|
||||||
| `tolerance` |`number` (`double`)| The tolerance for the fillet. | No |
|
| `tolerance` |`number`| The tolerance for the fillet. | No |
|
||||||
|
|
||||||
|
|
||||||
|
22
docs/kcl/types/GeoMeta.md
Normal file
22
docs/kcl/types/GeoMeta.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
title: "GeoMeta"
|
||||||
|
excerpt: "Geometry metadata."
|
||||||
|
layout: manual
|
||||||
|
---
|
||||||
|
|
||||||
|
Geometry metadata.
|
||||||
|
|
||||||
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description | Required |
|
||||||
|
|----------|------|-------------|----------|
|
||||||
|
| `id` |`string`| The id of the geometry. | No |
|
||||||
|
| `sourceRange` |`SourceRange`| The source range. | No |
|
||||||
|
|
||||||
|
|
@ -6,19 +6,19 @@ layout: manual
|
|||||||
|
|
||||||
Data for helices.
|
Data for helices.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `angleStart` |`number` (`double`)| Start angle (in degrees). | No |
|
| `revolutions` |`number`| Number of revolutions. | No |
|
||||||
| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is `false`. | No |
|
| `angleStart` |`number`| Start angle (in degrees). | No |
|
||||||
| `length` |`number` (`double`)| Length of the helix. If this argument is not provided, the height of the extrude group is used. | No |
|
| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is `false`. | No |
|
||||||
| `revolutions` |`number` (`double`)| Number of revolutions. | No |
|
| `length` |`number`| Length of the helix. If this argument is not provided, the height of the solid is used. | No |
|
||||||
|
|
||||||
|
|
||||||
|
@ -9,133 +9,124 @@ Import format specifier
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**This schema accepts exactly one of the following:**
|
**This schema accepts exactly one of the following:**
|
||||||
|
|
||||||
Autodesk Filmbox (FBX) format
|
Autodesk Filmbox (FBX) format
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `type` |enum: `fbx`
|
| `type` |enum: `fbx`| | No |
|
||||||
| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
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).
|
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`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `type` |enum: `gltf`
|
| `type` |enum: `gltf`| | No |
|
||||||
| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
Wavefront OBJ format.
|
Wavefront OBJ format.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
| `type` |enum: `obj`| | No |
|
||||||
| `type` |enum: `obj`
|
| `coords` |[`System`](/docs/kcl/types/System)| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
||||||
| | No |
|
| `units` |[`UnitLength`](/docs/kcl/types/UnitLength)| 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`
|
|
||||||
| 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 |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
The PLY Polygon File Format.
|
The PLY Polygon File Format.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
| `type` |enum: `ply`| | No |
|
||||||
| `type` |enum: `ply`
|
| `coords` |[`System`](/docs/kcl/types/System)| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
||||||
| | No |
|
| `units` |[`UnitLength`](/docs/kcl/types/UnitLength)| 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`
|
|
||||||
| 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 |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
SolidWorks part (SLDPRT) format.
|
SolidWorks part (SLDPRT) format.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `type` |enum: `sldprt`
|
| `type` |enum: `sldprt`| | No |
|
||||||
| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
ISO 10303-21 (STEP) format.
|
ISO 10303-21 (STEP) format.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `type` |enum: `step`
|
| `type` |enum: `step`| | No |
|
||||||
| | No |
|
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
ST**ereo**L**ithography format.
|
ST**ereo**L**ithography format.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `coords` |`object`| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
| `type` |enum: `stl`| | No |
|
||||||
| `type` |enum: `stl`
|
| `coords` |[`System`](/docs/kcl/types/System)| Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system. | No |
|
||||||
| | No |
|
| `units` |[`UnitLength`](/docs/kcl/types/UnitLength)| 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`
|
|
||||||
| 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,18 +6,18 @@ layout: manual
|
|||||||
|
|
||||||
Data for an imported geometry.
|
Data for an imported geometry.
|
||||||
|
|
||||||
|
|
||||||
**Type:** `object`
|
**Type:** `object`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
| Property | Type | Description | Required |
|
| Property | Type | Description | Required |
|
||||||
|----------|------|-------------|----------|
|
|----------|------|-------------|----------|
|
||||||
| `__meta` |`array`| | No |
|
| `id` |`string`| The ID of the imported geometry. | No |
|
||||||
| `id` |`string` (`uuid`)| The ID of the imported geometry. | No |
|
| `value` |`[` `string` `]`| The original file paths. | No |
|
||||||
| `value` |`array`| The original file paths. | No |
|
| `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| | No |
|
||||||
|
|
||||||
|
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user