Compare commits

..

12 Commits

Author SHA1 Message Date
690c9c8c8d unit test for revolve 2025-05-11 22:23:07 +02:00
0621e1a53e Docs content (#6792)
* Add documentation to modules, and some constants and types

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Improve the language reference

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-11 19:32:33 +12:00
f36b69f4f0 Source range for pipe value used as unlabelled arg (#6787)
Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-11 17:43:12 +12:00
92f7a62af2 Create JUnit reports from Rust tests (#6743) 2025-05-11 00:49:55 -04:00
f73831ac27 more subtract regression tests (#6831)
updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-05-10 19:23:55 -04:00
09f39499e9 add subtract regression tests (#6829)
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-05-10 13:48:38 -07:00
7ac4a9507b fix unwrap (#6825)
* fix unwrap

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add test

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* udaptes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
2025-05-10 13:00:14 -07:00
3956958452 Force idle stream to 5min and hide setting (#6810)
* Hide "Allow orbit in sketch mode" setting from the app

The ability to orbit while in sketch mode is not well-tested or
well-used, so we should pull it from the app. The easiest way to do that
is leave the setting in the WASM definition, but configure the setting
to be uneditable from the interface.

* pierremtb/adhoc/force-idle-stream-and-hide

---------

Co-authored-by: Frank Noirot <frankjohnson1993@gmail.com>
Co-authored-by: Frank Noirot <frank@zoo.dev>
2025-05-10 15:54:58 -04:00
0fe866ad8b Update utility sink sample (#6798)
* upadte utility sink sample

* remove old screenshot
2025-05-10 19:52:55 +00:00
cca498be04 Fix ENOENT error when opening the app with a path on Linux (#6813)
* Fix ENOENT error when opening the app with a path on Linux
Fixes #6796

* Clean up
2025-05-10 15:46:30 -04:00
max
039cb38d56 Fix deletion of unassigned standalone edge treatments (#6815)
* oops, make it nicer for no reason

* tests

* deleteTopLevelStatement

* little swap

* astMod edits

* typos

* add playwright test for chamfers

* scene.settled instead of page.waitForTimeout

* unfuck circular dep - move locateExtrudeDeclarator

* locateExtrudeDeclarator > locateVariableWithCallOrPipe

* fmt

* edit the comment
2025-05-10 16:53:05 +00:00
4fb7065ddf Fix sign error. (#6821)
* Fix sign error.

* Update kcl-samples simulation test output

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-05-10 08:45:05 -07:00
195 changed files with 35857 additions and 11840 deletions

13
.github/ci-cd-scripts/upload-results.sh vendored Executable file
View File

@ -0,0 +1,13 @@
#!/bin/bash
set -euo pipefail
BRANCH="${GITHUB_HEAD_REF:-${GITHUB_REF_NAME:-}}"
COMMIT="${CI_COMMIT_SHA:-${GITHUB_SHA:-}}"
curl --request POST \
--header "X-API-Key: ${TAB_API_KEY}" \
--form "project=https://github.com/KittyCAD/modeling-app" \
--form "branch=${BRANCH}" \
--form "commit=${COMMIT}" \
--form "tests=@test-results/junit.xml" \
${TAB_API_URL}/api/results/bulk

View File

@ -98,9 +98,7 @@ jobs:
popd
git add \
rust/kcl-lib/tests \
public/kcl-samples/manifest.json \
public/kcl-samples/README.md \
public/kcl-samples/screenshots
public/kcl-samples
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
@ -177,13 +175,19 @@ jobs:
cp nextest-archive.tar.zst rust/nextest-archive.tar.zst
ls -lah
cd rust
cargo nextest run\
--retries=10 --no-fail-fast --profile ci --archive-file nextest-archive.tar.zst \
cargo nextest run \
--retries=10 --no-fail-fast --profile=ci --archive-file nextest-archive.tar.zst \
--partition count:${{ matrix.partitionIndex}}/${{ matrix.partitionTotal }} \
2>&1 | tee /tmp/github-actions.log
env:
KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN_DEV}}
ZOO_HOST: https://api.dev.zoo.dev
- name: Upload results
if: always()
run: .github/ci-cd-scripts/upload-results.sh
env:
TAB_API_URL: ${{ secrets.TAB_API_URL }}
TAB_API_KEY: ${{ secrets.TAB_API_KEY }}
run-wasm-tests:
name: Run wasm tests
strategy:

View File

@ -0,0 +1,53 @@
---
title: "Arithmetic and logic"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
KCL supports the usual arithmetic operators on numbers and logic operators on booleans:
| Operator | Meaning |
|----------|---------|
| `+` | Addition |
| `-` | Subtraction or unary negation |
| `*` | Multiplication |
| `/` | Division |
| `%` | Modulus aka remainder |
| `^` | Power, e.g., `x ^ 2` means `x` squared |
| `&` | Logical 'and' |
| `|` | Logical 'or' |
| `!` | Unary logical 'not' |
KCL also supports comparsion operators which operate on numbers and produce booleans:
| Operator | Meaning |
|----------|---------|
| `==` | Equal |
| `!=` | Not equal |
| `<` | Less than |
| `>` | Greater than |
| `<=` | Less than or equal |
| `>=` | Greater than or equal |
Arithmetics and logic expressions can be arbitrairly combined with the usual rules of associativity and precedence, e.g.,
```
myMathExpression = 3 + 1 * 2 / 3 - 7
```
You can also nest expressions in parenthesis:
```
myMathExpression = 3 + (1 * 2 / (3 - 7))
```
KCL numbers are implemented using [floating point numbers](https://en.wikipedia.org/wiki/Floating-point_arithmetic). This means that there are occasionally representation and rounding issues, and some oddities such as supporting positive and negative zero.
Some operators can be applied to other types:
- `+` can be used to concatenate strings, e.g., `'hello' + ' ' + 'world!'`
- Unary `-` can be used with planes or line-like objects such as axes to produce an object with opposite orientation, e.g., `-XY` is a plain which is aligned with `XY` but whose normal aligns with the negative Z axis.
- The following operators can be used with solids as shorthand for CSG operations:
- `+` or `|` for [`union`](/docs/kcl-std/union).
- `-` for [`subtract`](/docs/kcl-std/subtract).
- `&` for [`intersect`](/docs/kcl-std/intersect)

View File

@ -0,0 +1,30 @@
---
title: "Attributes"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
Attributes are syntax which affects the language item they annotate. In KCL they are indicated using `@`. For example, `@settings` affects the file in which it appears.
There are two kinds of attributes: named and unnamed attributes. Named attributes (e.g., `@settings`) have a name immediately after the `@` (e.g., `settings`) and affect their surrounding scope. Unnamed attributes have no name and affect the following item, e.g.,
```kcl,norun
@(lengthUnit = ft, coords = opengl)
import "tests/inputs/cube.obj"
```
has an unnamed attribute on the `import` statement.
Named and unnamed attributes may take a parenthesized list of arguments (like a function). Named attributes may also appear without any arguments (e.g., `@no_std`).
## Named attributes
The `@settings` attribute affects the current file and accepts the following arguments: `defaultLengthUnit`, `defaultAngleUnit`, and `kclVersion`. See [settings](/docs/kcl-lang/settings) for details.
The `@no_std` attribute affects the current file, takes no arguments, and causes the standard library to not be implicitly available. It can still be used by being explicitly imported.
## Unnamed attributes
Unnamed attributes may be used on `import` statements when importing non-KCL files. See [projects, modules, and imports](/docs/kcl-lang/modules) for details.
Other unnamed attributes are used on functions inside the standard library, but these are not available in user code.

View File

@ -0,0 +1,46 @@
---
title: "Functions"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
We have support for defining your own functions. Functions can take in any
type of argument. Below is an example of the syntax:
```
fn myFn(x) {
return x
}
```
As you can see above `myFn` just returns whatever it is given.
KCL uses keyword arguments:
```
// If you declare a function like this
fn add(left, right) {
return left + right
}
// You can call it like this:
total = add(left = 1, right = 2)
```
Functions can also declare one *unlabeled* arg. If you do want to declare an unlabeled arg, it must
be the first arg declared.
```
// The @ indicates an argument is used without a label.
// Note that only the first argument can use @.
fn increment(@x) {
return x + 1
}
fn add(@x, delta) {
return x + delta
}
two = increment(1)
three = add(1, delta = 2)
```

View File

@ -1,12 +1,20 @@
---
title: "KCL Language Guide"
title: "KCL Language Reference"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
This is a reference for KCL. If you are learning KCL, you may prefer the [guide]() which explains
things in a more tutorial fashion.
## Topics
* [`Types`](/docs/kcl-lang/types)
* [`Modules`](/docs/kcl-lang/modules)
* [`Settings`](/docs/kcl-lang/settings)
* [`Known Issues`](/docs/kcl-lang/known-issues)
* [Pipelines](/docs/kcl-lang/pipelines)
* [Arithmetic and logic](/docs/kcl-lang/arithmetic)
* [Values and types](/docs/kcl-lang/types)
* [Numeric types and units](/docs/kcl-lang/numeric)
* [Functions](/docs/kcl-lang/functions)
* [Projects, modules, and imports](/docs/kcl-lang/modules)
* [Attributes](/docs/kcl-lang/attributes)
* [Settings](/docs/kcl-lang/settings)
* [Known Issues](/docs/kcl-lang/known-issues)

View File

@ -1,6 +1,6 @@
---
title: "Modules"
excerpt: "Documentation of modules for the KCL language for the Zoo Design Studio."
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---

46
docs/kcl-lang/numeric.md Normal file
View File

@ -0,0 +1,46 @@
---
title: "Numeric types and units"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
Numbers and numeric types in KCL include information about the units of the numbers. So rather than just having a number like `42`, we always have information about the units so we don't confuse 42 mm with 42 inches.
## Numeric literals
When writing a number literal, you can use a unit suffix to explicitly state the unit, e.g., `42mm`. The following units are available:
- Length units:
- metric: `mm`, `cm`, `m`
- imperial: `in`, `ft`, `yd`
- Angle units: `deg`, `rad`
- `_` to indicate a unitless number such as a count or ratio.
If you write a numeric literal without a suffix, then the defaults for the current file are used. These defaults are specified using the `@settings` attribute, see [settings](/docs/kcl-lang/settings) for details. Note that if using the defaults, the KCL interpreter won't know whether you intend the number to be a length, angle, or count and will treat it as being possibly any of them.
## Numeric types
Just like numbers carry units information, the `number` type also includes units information. Units are written in parentheses after the type, e.g., `number(mm)`.
Any of the suffixes described above can be used meaning that values with that type have the supplied units. E.g., `number(mm)` is the type of number values with mm units and `number(_)` is the type of number values with no units.
You can also use `number(Length)`, `number(Angle)`, or `number(Count)`. These types mean a number with any length, angle, or unitless (count) units, respectively (note that `number(_)` and `number(Count)` are equivalent since there is only one kind of unitless-ness).
## Function calls
When calling a function with an argument with numeric type, the declared numeric type in the function signature and the units of the argument value used in the function call must be compatible. Units are adjusted automatically. For example, if a function requires an argument with type `number(mm)`, then you can call it with `2in` and the units will be automatically adjusted, but calling it with `90deg` will cause an error.
## Mixing units with arithmetic
When doing arithmetic or comparisons, units will be adjusted as necessary if possible. However, often arithmetic expressions exceed the ability of KCL to accurately choose units which can result in warnings in your code or sometimes errors. In these cases, you will need to give KCL more information. Sometimes this can be done by making units explicit using suffixes. If not, then you will need to use *type ascription*, which asserts that an expression has the supplied type. For example, `(x * y): number(mm)` tells KCL that the units of `x * y` is mm. Note that type ascription does not do any adjustment of the numbers, e.g., `2mm: number(in)` has the value `2in` (note that this would be a very non-idiomatic way to use numeric type ascription, you could simply write `2in`. Usually type ascription is only necessary for supplying type information about the result of computation).
KCL has no support for area, volume, or other higher dimension units. When internal unit tracking requires multiple dimensions, KCL essentially gives up. This is usually where the extra type information described above is needed. If doing computation with higher dimensioned units, you must ensure that all adjustments occur before any computation. E.g., if you want to compute an area with unknown units, you must convert all numbers to the same unit before starting.
## Explicit conversions
You might sometimes need to convert from one unit to another for some calculation. You can do this implicitly when calling a function (see above), but if you can't or don't want to, then you can use the explicit conversion functions in the [`std::units`](/docs/kcl-std/modules/std-units) module.

View File

@ -0,0 +1,66 @@
---
title: "Pipelines"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
It can be hard to read repeated function calls, because of all the nested brackets.
```norun
i = 1
x = h(g(f(i)))
```
You can make this easier to read by breaking it into many declarations, but that is a bit annoying.
```norun
i = 1
x0 = f(i)
x1 = g(x0)
x = h(x1)
```
Instead, you can use the pipeline operator (`|>`) to simplify this.
Basically, `x |> f(%)` is a shorthand for `f(x)`. The left-hand side of the `|>` gets put into
the `%` in the right-hand side.
So, this means `x |> f(%) |> g(%)` is shorthand for `g(f(x))`. The code example above, with its
somewhat-clunky `x0` and `x1` constants could be rewritten as
```norun
i = 1
x = i
|> f(%)
|> g(%)
|> h(%)
```
This helps keep your code neat and avoid unnecessary declarations.
## Pipelines and keyword arguments
Say you have a long pipeline of sketch functions, like this:
```norun
startSketchOn(XZ)
|> line(%, end = [3, 4])
|> line(%, end = [10, 10])
|> line(%, end = [-13, -14])
|> close(%)
```
In this example, each function call outputs a sketch, and it gets put into the next function call via
the `%`, into the first (unlabeled) argument.
If a function call uses an unlabeled first parameter, it will default to `%` if it's not given. This
means that `|> line(%, end = [3, 4])` and `|> line(end = [3, 4])` are equivalent! So the above
could be rewritten as
```norun
startSketchOn(XZ)
|> line(end = [3, 4])
|> line(end = [10, 10])
|> line(end = [-13, -14])
|> close()
```

View File

@ -1,6 +1,6 @@
---
title: "Settings"
excerpt: "Documentation of settings for the KCL language and Zoo Design Studio."
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---

View File

@ -1,6 +1,6 @@
---
title: "Types"
excerpt: "Documentation of types for the KCL standard library for the Zoo Design Studio."
title: "Values and types"
excerpt: "Documentation of the KCL language for the Zoo Design Studio."
layout: manual
---
@ -52,131 +52,6 @@ their internal components. See the [modules and imports docs](modules) for more
detail on importing geometry.
## Binary expressions
You can also do math! Let's show an example below:
```
myMathExpression = 3 + 1 * 2 / 3 - 7
```
You can nest expressions in parenthesis as well:
```
myMathExpression = 3 + (1 * 2 / (3 - 7))
```
## Functions
We also have support for defining your own functions. Functions can take in any
type of argument. Below is an example of the syntax:
```
fn myFn(x) {
return x
}
```
As you can see above `myFn` just returns whatever it is given.
KCL's early drafts used positional arguments, but we now use keyword arguments:
```
// If you declare a function like this
fn add(left, right) {
return left + right
}
// You can call it like this:
total = add(left = 1, right = 2)
```
Functions can also declare one *unlabeled* arg. If you do want to declare an unlabeled arg, it must
be the first arg declared.
```
// The @ indicates an argument can be used without a label.
// Note that only the first argument can use @.
fn increment(@x) {
return x + 1
}
fn add(@x, delta) {
return x + delta
}
two = increment(1)
three = add(1, delta = 2)
```
## Pipelines
It can be hard to read repeated function calls, because of all the nested brackets.
```norun
i = 1
x = h(g(f(i)))
```
You can make this easier to read by breaking it into many declarations, but that is a bit annoying.
```norun
i = 1
x0 = f(i)
x1 = g(x0)
x = h(x1)
```
Instead, you can use the pipeline operator (`|>`) to simplify this.
Basically, `x |> f(%)` is a shorthand for `f(x)`. The left-hand side of the `|>` gets put into
the `%` in the right-hand side.
So, this means `x |> f(%) |> g(%)` is shorthand for `g(f(x))`. The code example above, with its
somewhat-clunky `x0` and `x1` constants could be rewritten as
```norun
i = 1
x = i
|> f(%)
|> g(%)
|> h(%)
```
This helps keep your code neat and avoid unnecessary declarations.
## Pipelines and keyword arguments
Say you have a long pipeline of sketch functions, like this:
```norun
startSketchOn(XZ)
|> line(%, end = [3, 4])
|> line(%, end = [10, 10])
|> line(%, end = [-13, -14])
|> close(%)
```
In this example, each function call outputs a sketch, and it gets put into the next function call via
the `%`, into the first (unlabeled) argument.
If a function call uses an unlabeled first parameter, it will default to `%` if it's not given. This
means that `|> line(%, end = [3, 4])` and `|> line(end = [3, 4])` are equivalent! So the above
could be rewritten as
```norun
startSketchOn(XZ)
|> line(end = [3, 4])
|> line(end = [10, 10])
|> line(end = [-13, -14])
|> close()
```
Note that we are still in the process of migrating KCL's standard library to use keyword arguments. So some
functions are still unfortunately using positional arguments. We're moving them over, so keep checking back.
Some functions are still using the old positional argument syntax.
Check the docs page for each function and look at its examples to see.
## Tags
Tags are used to give a name (tag) to a specific path.
@ -291,7 +166,6 @@ See how we use the tag `rectangleSegmentA001` in the `fillet` function outside
the `rect` function. This is because the `rect` function is returning the
sketch group that contains the tags.
---
If you find any issues using any of the above expressions or syntax,

View File

@ -1,11 +1,11 @@
---
title: "X"
subtitle: "Constant in std"
excerpt: ""
excerpt: "The X-axis (can be used in both 2d and 3d contexts)."
layout: manual
---
The X-axis (can be used in both 2d and 3d contexts).
```kcl
X

View File

@ -1,11 +1,11 @@
---
title: "XY"
subtitle: "Constant in std"
excerpt: ""
excerpt: "An abstract 3d plane aligned with the X and Y axes. Its normal is the positive Z axis."
layout: manual
---
An abstract 3d plane aligned with the X and Y axes. Its normal is the positive Z axis.
```kcl
XY

View File

@ -1,11 +1,11 @@
---
title: "XZ"
subtitle: "Constant in std"
excerpt: ""
excerpt: "An abstract 3d plane aligned with the X and Z axes. Its normal is the negative Y axis."
layout: manual
---
An abstract 3d plane aligned with the X and Z axes. Its normal is the negative Y axis.
```kcl
XZ

View File

@ -1,11 +1,11 @@
---
title: "Y"
subtitle: "Constant in std"
excerpt: ""
excerpt: "The Y-axis (can be used in both 2d and 3d contexts)."
layout: manual
---
The Y-axis (can be used in both 2d and 3d contexts).
```kcl
Y

View File

@ -1,11 +1,11 @@
---
title: "YZ"
subtitle: "Constant in std"
excerpt: ""
excerpt: "An abstract 3d plane aligned with the Y and Z axes. Its normal is the positive X axis."
layout: manual
---
An abstract 3d plane aligned with the Y and Z axes. Its normal is the positive X axis.
```kcl
YZ

View File

@ -1,11 +1,11 @@
---
title: "Z"
subtitle: "Constant in std"
excerpt: ""
excerpt: "The 3D Z-axis."
layout: manual
---
The 3D Z-axis.
```kcl
Z

View File

@ -1,11 +1,11 @@
---
title: "turns::HALF_TURN"
subtitle: "Constant in std::turns"
excerpt: ""
excerpt: "A half turn, 180 degrees or π radians."
layout: manual
---
A half turn, 180 degrees or π radians.
```kcl
turns::HALF_TURN: number(deg) = 180deg

View File

@ -1,11 +1,11 @@
---
title: "turns::QUARTER_TURN"
subtitle: "Constant in std::turns"
excerpt: ""
excerpt: "A quarter turn, 90 degrees or π/2 radians."
layout: manual
---
A quarter turn, 90 degrees or π/2 radians.
```kcl
turns::QUARTER_TURN: number(deg) = 90deg

View File

@ -1,11 +1,11 @@
---
title: "turns::THREE_QUARTER_TURN"
subtitle: "Constant in std::turns"
excerpt: ""
excerpt: "Three quarters of a turn, 270 degrees or 1.5*π radians."
layout: manual
---
Three quarters of a turn, 270 degrees or 1.5*π radians.
```kcl
turns::THREE_QUARTER_TURN: number(deg) = 270deg

View File

@ -1,11 +1,11 @@
---
title: "turns::ZERO"
subtitle: "Constant in std::turns"
excerpt: ""
excerpt: "No turn, zero degrees/radians."
layout: manual
---
No turn, zero degrees/radians.
```kcl
turns::ZERO: number = 0

View File

@ -35,7 +35,7 @@ helix(
### Returns
[`Helix`](/docs/kcl-std/types/std-types-Helix) - A helix.
[`Helix`](/docs/kcl-std/types/std-types-Helix) - A helix; created by the `helix` function.
### Examples

View File

@ -17,11 +17,11 @@ abs(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ acos(@num: number(_)): number(rad)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ asin(@num: number(_)): number(rad)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ Consider using `atan2()` instead for the true inverse of tangent.
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(_)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -20,12 +20,12 @@ atan2(
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `y` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `x` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `y` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
| `x` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ ceil(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ cos(@num: number(Angle)): number(_)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ floor(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ ln(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -27,7 +27,7 @@ and `log10` can produce more accurate results for base 10.
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ log10(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ log2(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ max(@input: [number; 1+]): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ min(@input: [number; 1+]): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,8 +21,8 @@ cartesian (x/y/z grid) coordinates.
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `angle` | [`number(rad)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `angle` | [`number(rad)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
| `length` | [`number(Length)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns

View File

@ -25,7 +25,7 @@ pow(
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -26,7 +26,7 @@ If `num` is negative, the result will be too.
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ round(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ sin(@num: number(Angle)): number(_)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ sqrt(@input: number): number
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `input` | [`number`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ tan(@num: number(Angle)): number(_)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(Angle)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number
[`number(_)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -26,7 +26,7 @@ plane and 10 units away from it.
### Returns
[`Plane`](/docs/kcl-std/types/std-types-Plane) - A plane.
[`Plane`](/docs/kcl-std/types/std-types-Plane) - An abstract plane.
### Examples

View File

@ -46,7 +46,7 @@ revolved around the same axis.
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extruded surfaces.
### Examples

View File

@ -31,7 +31,7 @@ a sharp, straight transitional edge.
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extruded surfaces.
### Examples

View File

@ -33,7 +33,7 @@ will smoothly blend the transition.
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extruded surfaces.
### Examples

View File

@ -26,7 +26,7 @@ provided thickness remains around the exterior of the shape.
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extruded surfaces.
### Examples

View File

@ -17,11 +17,11 @@ units::toCentimeters(@num: number(cm)): number(cm)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(cm)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(cm)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(cm)`](/docs/kcl-std/types/std-types-number) - A number
[`number(cm)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -17,11 +17,11 @@ units::toDegrees(@num: number(deg)): number(deg)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(deg)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(deg)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(deg)`](/docs/kcl-std/types/std-types-number) - A number
[`number(deg)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ units::toFeet(@num: number(ft)): number(ft)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(ft)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(ft)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(ft)`](/docs/kcl-std/types/std-types-number) - A number
[`number(ft)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -17,11 +17,11 @@ units::toInches(@num: number(in)): number(in)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(in)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(in)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(in)`](/docs/kcl-std/types/std-types-number) - A number
[`number(in)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -17,11 +17,11 @@ units::toMeters(@num: number(m)): number(m)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(m)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(m)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(m)`](/docs/kcl-std/types/std-types-number) - A number
[`number(m)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -17,11 +17,11 @@ units::toMillimeters(@num: number(mm)): number(mm)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(mm)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(mm)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(mm)`](/docs/kcl-std/types/std-types-number) - A number
[`number(mm)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -17,11 +17,11 @@ units::toRadians(@num: number(rad)): number(rad)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(rad)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(rad)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number
[`number(rad)`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -17,11 +17,11 @@ units::toYards(@num: number(yd)): number(yd)
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `num` | [`number(yd)`](/docs/kcl-std/types/std-types-number) | A number | Yes |
| `num` | [`number(yd)`](/docs/kcl-std/types/std-types-number) | A number. | Yes |
### Returns
[`number(yd)`](/docs/kcl-std/types/std-types-number) - A number
[`number(yd)`](/docs/kcl-std/types/std-types-number) - A number.

View File

@ -21,7 +21,7 @@ lastSegX(@sketch: Sketch): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ lastSegY(@sketch: Sketch): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -25,7 +25,7 @@ legAngX(
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -25,7 +25,7 @@ legAngY(
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -25,7 +25,7 @@ legLen(
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -35,7 +35,7 @@ The sketches need to closed and on the same plane.
### Returns
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extrude surfaces.
[`Solid`](/docs/kcl-std/types/std-types-Solid) - A solid is a collection of extruded surfaces.
### Examples

View File

@ -1,11 +1,11 @@
---
title: "array"
subtitle: "Module in std"
excerpt: ""
excerpt: "Functions for manipulating arrays of values. "
layout: manual
---
Functions for manipulating arrays of values.

View File

@ -1,11 +1,11 @@
---
title: "math"
subtitle: "Module in std"
excerpt: ""
excerpt: "Functions for mathematical operations and some useful constants. "
layout: manual
---
Functions for mathematical operations and some useful constants.

View File

@ -1,13 +1,13 @@
---
title: "sketch"
subtitle: "Module in std"
excerpt: ""
excerpt: "Sketching is the foundational activity for most KCL programs. A sketch is a two-dimensional drawing made from paths or shapes. A sketch is always drawn on a surface (either an abstract plane of a face of a solid). A sketch can be made into a solid by extruding it (or revolving, etc.). "
layout: manual
---
Sketching is the foundational activity for most KCL programs. A sketch is a two-dimensional drawing made from paths or shapes. A sketch is always drawn on a surface (either an abstract plane of a face of a solid). A sketch can be made into a solid by extruding it (or revolving, etc.).
This module contains functions for creating and manipulating sketches, and making them into solids.
## Functions and constants

View File

@ -1,11 +1,11 @@
---
title: "solid"
subtitle: "Module in std"
excerpt: ""
excerpt: "This module contains functions for modifying solids, e.g., by adding a fillet or chamfer, or removing part of a solid. "
layout: manual
---
This module contains functions for modifying solids, e.g., by adding a fillet or chamfer, or removing part of a solid.

View File

@ -1,11 +1,11 @@
---
title: "transform"
subtitle: "Module in std"
excerpt: ""
excerpt: "This module contains functions for transforming sketches and solids. "
layout: manual
---
This module contains functions for transforming sketches and solids.

View File

@ -1,11 +1,11 @@
---
title: "turns"
subtitle: "Module in std"
excerpt: ""
excerpt: "This module contains a few handy constants for defining turns. "
layout: manual
---
This module contains a few handy constants for defining turns.

View File

@ -1,13 +1,13 @@
---
title: "types"
subtitle: "Module in std"
excerpt: ""
excerpt: "KCL types. This module contains fundamental types like `number`, `string`, `Solid`, and `Sketch`. "
layout: manual
---
KCL types. This module contains fundamental types like `number`, `string`, `Solid`, and `Sketch`.
Types can (optionally) be used to describe a function's arguments and returned value. They are checked when a program runs and can help avoid errors. They are also useful to help document what a function does.

View File

@ -7,7 +7,9 @@ layout: manual
Functions for converting numbers to different units.
All numbers in KCL include units, e.g., the number `42` is always '42 mm' or '42 degrees', etc. it is never just '42'. For more information, see [numeric types](/docs/kcl-lang/numeric).
Note that you only need to explicitly convert the units of a number if you need a specific unit for your own calculations. When calling a function, KCL will convert a number to the required units automatically (where possible, and give an error or warning if it's not possible).
## Functions and constants

View File

@ -9,6 +9,8 @@ The KCL standard library
Contains frequently used constants, functions for interacting with the KittyCAD servers to create sketches and geometry, and utility functions.
The standard library is organised into modules (listed below), but most things are always available in KCL programs.
## Modules
* [`array`](/docs/kcl-std/modules/std-array)

View File

@ -21,7 +21,7 @@ profileStartX(@profile: Sketch): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ profileStartY(@profile: Sketch): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segAng(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segEndX(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segEndY(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segLen(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segStartX(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ segStartY(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -21,7 +21,7 @@ tangentToEnd(@tag: TagIdentifier): number
### Returns
[`number`](/docs/kcl-std/types/std-types-number) - A number
[`number`](/docs/kcl-std/types/std-types-number) - A number.
### Examples

View File

@ -1,11 +1,11 @@
---
title: "Axis2d"
subtitle: "Type in std::types"
excerpt: "An infinite line in 2d space."
excerpt: "An abstract and infinite line in 2d space."
layout: manual
---
An infinite line in 2d space.
An abstract and infinite line in 2d space.

View File

@ -1,11 +1,11 @@
---
title: "Axis3d"
subtitle: "Type in std::types"
excerpt: "An infinite line in 3d space."
excerpt: "An abstract and infinite line in 3d space."
layout: manual
---
An infinite line in 3d space.
An abstract and infinite line in 3d space.

View File

@ -1,11 +1,11 @@
---
title: "Edge"
subtitle: "Type in std::types"
excerpt: "The edge of a solid."
excerpt: "An edge of a solid."
layout: manual
---
The edge of a solid.
An edge of a solid.

View File

@ -1,11 +1,11 @@
---
title: "Face"
subtitle: "Type in std::types"
excerpt: "A face."
excerpt: "A face of a solid."
layout: manual
---
A face.
A face of a solid.

View File

@ -1,11 +1,11 @@
---
title: "Helix"
subtitle: "Type in std::types"
excerpt: "A helix."
excerpt: "A helix; created by the `helix` function."
layout: manual
---
A helix.
A helix; created by the `helix` function.

View File

@ -1,13 +1,14 @@
---
title: "Plane"
subtitle: "Type in std::types"
excerpt: "A plane."
excerpt: "An abstract plane."
layout: manual
---
A plane.
An abstract plane.
A plane has a position and orientation in space defined by its origin and axes. A plane can be used
to sketch on.

View File

@ -1,11 +1,11 @@
---
title: "Solid"
subtitle: "Type in std::types"
excerpt: "A solid is a collection of extrude surfaces."
excerpt: "A solid is a collection of extruded surfaces."
layout: manual
---
A solid is a collection of extrude surfaces.
A solid is a collection of extruded surfaces.
When you define a solid to a variable like:

View File

@ -1,13 +1,28 @@
---
title: "any"
subtitle: "Type in std::types"
excerpt: "Any value."
excerpt: ""
layout: manual
---
Any value.
The [`any`](/docs/kcl-std/types/std-types-any) type is the type of all possible values in KCL. I.e., if a function accepts an argument
with type [`any`](/docs/kcl-std/types/std-types-any), then it can accept any value.
### Examples
```kcl
fn acceptAnything(@input: any) {
return true
}
acceptAnything(42)
acceptAnything('hello')
acceptAnything(XY)
acceptAnything([0, 1, 2])
```

View File

@ -7,7 +7,7 @@ layout: manual
A boolean value.
`true` or `false`
`true` or `false`.

View File

@ -1,15 +1,28 @@
---
title: "number"
subtitle: "Type in std::types"
excerpt: "A number"
excerpt: "A number."
layout: manual
---
A number
A number.
May be signed or unsigned, an integer or decimal value.
You may see a number type with units, e.g., [`number(mm)`](/docs/kcl-std/types/std-types-number). These are currently experimental.
KCL numbers always include units, e.g., the number `42` is always '42 mm' or '42 degrees', etc.
it is never just '42'. The [`number`](/docs/kcl-std/types/std-types-number) type may or may not include units, if none are specified, then
it is the type of any number. E.g.,
- [`number`](/docs/kcl-std/types/std-types-number): the type of any numbers,
- [`number(mm)`](/docs/kcl-std/types/std-types-number): the type of numbers in millimeters,
- [`number(in)`](/docs/kcl-std/types/std-types-number): the type of numbers in inches,
- [`number(Length)`](/docs/kcl-std/types/std-types-number): the type of numbers in any length unit,
- [`number(deg)`](/docs/kcl-std/types/std-types-number): the type of numbers in degrees,
- [`number(Angle)`](/docs/kcl-std/types/std-types-number): the type of numbers in any angle unit,
- [`number(_)`](/docs/kcl-std/types/std-types-number) or [`number(Count)`](/docs/kcl-std/types/std-types-number): the type of unit-less numbers, representing a count of things,
or a ratio, etc.
For more information, see [numeric types](/docs/kcl-lang/numeric).

View File

@ -2388,6 +2388,7 @@ fillet001 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg01)])
scene,
editor,
toolbar,
cmdBar,
}) => {
// Code samples
const initialCode = `sketch001 = startSketchOn(XY)
@ -2401,14 +2402,14 @@ extrude001 = extrude(sketch001, length = -12)
|> fillet(radius = 5, tags = [seg01]) // fillet01
|> fillet(radius = 5, tags = [seg02]) // fillet02
fillet03 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg01)])
fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
`
const pipedFilletDeclaration = 'fillet(radius = 5, tags = [seg01])'
const firstPipedFilletDeclaration = 'fillet(radius = 5, tags = [seg01])'
const secondPipedFilletDeclaration = 'fillet(radius = 5, tags = [seg02])'
const standaloneFilletDeclaration =
const standaloneAssignedFilletDeclaration =
'fillet03 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg01)])'
const secondStandaloneFilletDeclaration =
'fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])'
const standaloneUnassignedFilletDeclaration =
'fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])'
// Locators
const pipedFilletEdgeLocation = { x: 600, y: 193 }
@ -2430,6 +2431,7 @@ fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
}, initialCode)
await page.setBodyDimensions({ width: 1000, height: 500 })
await homePage.goToModelingScene()
await scene.settled(cmdBar)
// verify modeling scene is loaded
await scene.expectPixelColor(
@ -2446,15 +2448,19 @@ fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
await test.step('Delete fillet via feature tree selection', async () => {
await test.step('Open Feature Tree Pane', async () => {
await toolbar.openPane('feature-tree')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Delete piped fillet via feature tree selection', async () => {
await test.step('Verify all fillets are present in the editor', async () => {
await editor.expectEditor.toContain(pipedFilletDeclaration)
await editor.expectEditor.toContain(firstPipedFilletDeclaration)
await editor.expectEditor.toContain(secondPipedFilletDeclaration)
await editor.expectEditor.toContain(standaloneFilletDeclaration)
await editor.expectEditor.toContain(secondStandaloneFilletDeclaration)
await editor.expectEditor.toContain(
standaloneAssignedFilletDeclaration
)
await editor.expectEditor.toContain(
standaloneUnassignedFilletDeclaration
)
})
await test.step('Verify test fillets are present in the scene', async () => {
await scene.expectPixelColor(
@ -2475,13 +2481,17 @@ fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Verify piped fillet is deleted but other fillets are not (in the editor)', async () => {
await editor.expectEditor.not.toContain(pipedFilletDeclaration)
await editor.expectEditor.not.toContain(firstPipedFilletDeclaration)
await editor.expectEditor.toContain(secondPipedFilletDeclaration)
await editor.expectEditor.toContain(standaloneFilletDeclaration)
await editor.expectEditor.toContain(secondStandaloneFilletDeclaration)
await editor.expectEditor.toContain(
standaloneAssignedFilletDeclaration
)
await editor.expectEditor.toContain(
standaloneUnassignedFilletDeclaration
)
})
await test.step('Verify piped fillet is deleted but non-piped is not (in the scene)', async () => {
await scene.expectPixelColor(
@ -2497,22 +2507,51 @@ fillet04 = fillet(extrude001, radius = 5, tags = [getOppositeEdge(seg02)])
})
})
await test.step('Delete non-piped fillet via feature tree selection', async () => {
await test.step('Delete non-piped fillet', async () => {
await test.step('Delete standalone assigned fillet via feature tree selection', async () => {
await test.step('Delete standalone assigned fillet', async () => {
const operationButton = await toolbar.getFeatureTreeOperation(
'Fillet',
1
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Verify non-piped fillet is deleted but other two fillets are not (in the editor)', async () => {
await test.step('Verify standalone assigned fillet is deleted but other two fillets are not (in the editor)', async () => {
await editor.expectEditor.toContain(secondPipedFilletDeclaration)
await editor.expectEditor.not.toContain(standaloneFilletDeclaration)
await editor.expectEditor.toContain(secondStandaloneFilletDeclaration)
await editor.expectEditor.not.toContain(
standaloneAssignedFilletDeclaration
)
await editor.expectEditor.toContain(
standaloneUnassignedFilletDeclaration
)
})
await test.step('Verify non-piped fillet is deleted but piped is not (in the scene)', async () => {
await test.step('Verify standalone assigned fillet is deleted but piped is not (in the scene)', async () => {
await scene.expectPixelColor(
edgeColorWhite,
standaloneFilletEdgeLocation,
lowTolerance
)
})
})
await test.step('Delete standalone unassigned fillet via feature tree selection', async () => {
await test.step('Delete standalone unassigned fillet', async () => {
const operationButton = await toolbar.getFeatureTreeOperation(
'Fillet',
1
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await scene.settled(cmdBar)
})
await test.step('Verify standalone unassigned fillet is deleted but other fillet is not (in the editor)', async () => {
await editor.expectEditor.toContain(secondPipedFilletDeclaration)
await editor.expectEditor.not.toContain(
standaloneUnassignedFilletDeclaration
)
})
await test.step('Verify standalone unassigned fillet is deleted but piped is not (in the scene)', async () => {
await scene.expectPixelColor(
edgeColorWhite,
standaloneFilletEdgeLocation,
@ -2964,14 +3003,14 @@ extrude001 = extrude(sketch001, length = -12)
|> chamfer(length = 5, tags = [seg01]) // chamfer01
|> chamfer(length = 5, tags = [seg02]) // chamfer02
chamfer03 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg01)])
chamfer04 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])
chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])
`
const pipedChamferDeclaration = 'chamfer(length = 5, tags = [seg01])'
const firstPipedChamferDeclaration = 'chamfer(length = 5, tags = [seg01])'
const secondPipedChamferDeclaration = 'chamfer(length = 5, tags = [seg02])'
const standaloneChamferDeclaration =
const standaloneAssignedChamferDeclaration =
'chamfer03 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg01)])'
const secondStandaloneChamferDeclaration =
'chamfer04 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])'
const standaloneUnassignedChamferDeclaration =
'chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])'
// Locators
const pipedChamferEdgeLocation = { x: 600, y: 193 }
@ -3010,16 +3049,18 @@ chamfer04 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])
await test.step('Delete chamfer via feature tree selection', async () => {
await test.step('Open Feature Tree Pane', async () => {
await toolbar.openPane('feature-tree')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Delete piped chamfer via feature tree selection', async () => {
await test.step('Verify all chamfers are present in the editor', async () => {
await editor.expectEditor.toContain(pipedChamferDeclaration)
await editor.expectEditor.toContain(firstPipedChamferDeclaration)
await editor.expectEditor.toContain(secondPipedChamferDeclaration)
await editor.expectEditor.toContain(standaloneChamferDeclaration)
await editor.expectEditor.toContain(
secondStandaloneChamferDeclaration
standaloneAssignedChamferDeclaration
)
await editor.expectEditor.toContain(
standaloneUnassignedChamferDeclaration
)
})
await test.step('Verify test chamfers are present in the scene', async () => {
@ -3041,14 +3082,16 @@ chamfer04 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Verify piped chamfer is deleted but other chamfers are not (in the editor)', async () => {
await editor.expectEditor.not.toContain(pipedChamferDeclaration)
await editor.expectEditor.not.toContain(firstPipedChamferDeclaration)
await editor.expectEditor.toContain(secondPipedChamferDeclaration)
await editor.expectEditor.toContain(standaloneChamferDeclaration)
await editor.expectEditor.toContain(
secondStandaloneChamferDeclaration
standaloneAssignedChamferDeclaration
)
await editor.expectEditor.toContain(
standaloneUnassignedChamferDeclaration
)
})
await test.step('Verify piped chamfer is deleted but non-piped is not (in the scene)', async () => {
@ -3065,24 +3108,51 @@ chamfer04 = chamfer(extrude001, length = 5, tags = [getOppositeEdge(seg02)])
})
})
await test.step('Delete non-piped chamfer via feature tree selection', async () => {
await test.step('Delete non-piped chamfer', async () => {
await test.step('Delete standalone assigned chamfer via feature tree selection', async () => {
await test.step('Delete standalone assigned chamfer', async () => {
const operationButton = await toolbar.getFeatureTreeOperation(
'Chamfer',
1
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await page.waitForTimeout(500)
await scene.settled(cmdBar)
})
await test.step('Verify non-piped chamfer is deleted but other two chamfers are not (in the editor)', async () => {
await test.step('Verify standalone assigned chamfer is deleted but other two chamfers are not (in the editor)', async () => {
await editor.expectEditor.toContain(secondPipedChamferDeclaration)
await editor.expectEditor.not.toContain(standaloneChamferDeclaration)
await editor.expectEditor.not.toContain(
standaloneAssignedChamferDeclaration
)
await editor.expectEditor.toContain(
secondStandaloneChamferDeclaration
standaloneUnassignedChamferDeclaration
)
})
await test.step('Verify non-piped chamfer is deleted but piped is not (in the scene)', async () => {
await test.step('Verify standalone assigned chamfer is deleted but piped is not (in the scene)', async () => {
await scene.expectPixelColor(
edgeColorWhite,
standaloneChamferEdgeLocation,
lowTolerance
)
})
})
await test.step('Delete standalone unassigned chamfer via feature tree selection', async () => {
await test.step('Delete standalone unassigned chamfer', async () => {
const operationButton = await toolbar.getFeatureTreeOperation(
'Chamfer',
1
)
await operationButton.click({ button: 'left' })
await page.keyboard.press('Delete')
await scene.settled(cmdBar)
})
await test.step('Verify standalone unassigned chamfer is deleted but piped chamfer is not (in the editor)', async () => {
await editor.expectEditor.toContain(secondPipedChamferDeclaration)
await editor.expectEditor.not.toContain(
standaloneUnassignedChamferDeclaration
)
})
await test.step('Verify standalone unassigned chamfer is deleted but piped is not (in the scene)', async () => {
await scene.expectPixelColor(
edgeColorWhite,
standaloneChamferEdgeLocation,

View File

@ -20,7 +20,7 @@ KCL samples conform to a set of style guidelines to ensure consistency and reada
## Snapshot and export
When you submit a PR to add or modify KCL samples, images and STEP files will be generated and added to the repository automatically.
When you submit a PR to add or modify KCL samples, images will be generated and added to the repository automatically.
---
#### [80-20-rail](80-20-rail/main.kcl) ([screenshot](screenshots/80-20-rail.png))
@ -43,8 +43,6 @@ When you submit a PR to add or modify KCL samples, images and STEP files will be
[![cycloidal-gear](screenshots/cycloidal-gear.png)](cycloidal-gear/main.kcl)
#### [dodecahedron](dodecahedron/main.kcl) ([screenshot](screenshots/dodecahedron.png))
[![dodecahedron](screenshots/dodecahedron.png)](dodecahedron/main.kcl)
#### [dual-basin-utility-sink](dual-basin-utility-sink/main.kcl) ([screenshot](screenshots/dual-basin-utility-sink.png))
[![dual-basin-utility-sink](screenshots/dual-basin-utility-sink.png)](dual-basin-utility-sink/main.kcl)
#### [enclosure](enclosure/main.kcl) ([screenshot](screenshots/enclosure.png))
[![enclosure](screenshots/enclosure.png)](enclosure/main.kcl)
#### [exhaust-manifold](exhaust-manifold/main.kcl) ([screenshot](screenshots/exhaust-manifold.png))
@ -103,6 +101,8 @@ When you submit a PR to add or modify KCL samples, images and STEP files will be
[![sheet-metal-bracket](screenshots/sheet-metal-bracket.png)](sheet-metal-bracket/main.kcl)
#### [socket-head-cap-screw](socket-head-cap-screw/main.kcl) ([screenshot](screenshots/socket-head-cap-screw.png))
[![socket-head-cap-screw](screenshots/socket-head-cap-screw.png)](socket-head-cap-screw/main.kcl)
#### [utility-sink](utility-sink/main.kcl) ([screenshot](screenshots/utility-sink.png))
[![utility-sink](screenshots/utility-sink.png)](utility-sink/main.kcl)
#### [walkie-talkie](walkie-talkie/main.kcl) ([screenshot](screenshots/walkie-talkie.png))
[![walkie-talkie](screenshots/walkie-talkie.png)](walkie-talkie/main.kcl)
#### [washer](washer/main.kcl) ([screenshot](screenshots/washer.png))

View File

@ -37,7 +37,7 @@ secondaryRotorSketch = startSketchOn(centerSpacer, face = END)
secondRotor = extrude(secondaryRotorSketch, length = rotorSinglePlateThickness)
lugHoles2 = startSketchOn(secondRotor, face = END)
|> circle(center = [-lugSpacing / 2, 0], radius = 0.315)
|> circle(center = [lugSpacing / 2, 0], radius = 0.315)
|> patternCircular2d(
arcDegrees = 360,
center = [0, 0],

View File

@ -110,16 +110,6 @@
"main.kcl"
]
},
{
"file": "main.kcl",
"pathFromProjectDirectoryToFirstFile": "dual-basin-utility-sink/main.kcl",
"multipleFiles": false,
"title": "Dual-Basin Utility Sink",
"description": "A stainless steel sink unit with dual rectangular basins and six under-counter storage compartments.",
"files": [
"main.kcl"
]
},
{
"file": "main.kcl",
"pathFromProjectDirectoryToFirstFile": "enclosure/main.kcl",
@ -422,6 +412,16 @@
"main.kcl"
]
},
{
"file": "main.kcl",
"pathFromProjectDirectoryToFirstFile": "utility-sink/main.kcl",
"multipleFiles": false,
"title": "Utility Sink",
"description": "A stainless steel sink unit with a configurable number of rectangular basins and under-counter storage compartments.",
"files": [
"main.kcl"
]
},
{
"file": "main.kcl",
"pathFromProjectDirectoryToFirstFile": "walkie-talkie/main.kcl",

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -1,19 +1,19 @@
// Dual-Basin Utility Sink
// A stainless steel sink unit with dual rectangular basins and six under-counter storage compartments.
// Utility Sink
// A stainless steel sink unit with a configurable number of rectangular basins and under-counter storage compartments.
// Set units
@settings(defaultLengthUnit = mm, kclVersion = 1.0)
// Define parameters
tableHeight = 850
tableWidth = 3400
tableDepth = 400
tableWidth = 1200
tableDepth = 600
profileThickness = 13
metalThickness = 2
blockCount = 3
blockWidth = (tableWidth - profileThickness) / 3
blockCount = 1
blockWidth = (tableWidth - profileThickness) / blockCount
blockHeight = tableHeight - metalThickness - 0.5
blockDepth = tableDepth - profileThickness
@ -109,12 +109,12 @@ tableTopBody = startProfile(tableTopPlane, at = [0, 0])
|> close()
|> extrude(length = -metalThickness)
sinkCount = 2
sinkWidth = 1000
sinkLength = 250
sinkCount = blockCount
sinkWidth = blockWidth / 2
sinkLength = tableDepth - 150
sinkDepth = 200
sinkOffsetFront = 40
sinkOffsetLeft = 350
sinkOffsetLeft = (blockWidth - sinkWidth) / 2
sinkSpacing = tableWidth - sinkWidth - (sinkOffsetLeft * 2)
sinkPlaneOutside = startSketchOn(tableTopBody, face = START)
@ -143,6 +143,24 @@ sinkBodyInside = startProfile(
|> patternLinear2d(axis = [1, 0], instances = sinkCount, distance = sinkSpacing)
|> extrude(length = -sinkDepth)
// tap
tapPlate = startSketchOn(offsetPlane(XY, offset = tableHeight))
|> circle(%, center = [blockWidth / 2, tableDepth - 55], radius = 40)
|> patternLinear2d(axis = [1, 0], instances = sinkCount, distance = sinkSpacing)
|> extrude(length = 5)
tapPillar = startSketchOn(offsetPlane(XY, offset = tableHeight))
|> circle(%, center = [blockWidth / 2, tableDepth - 55], radius = 15)
|> patternLinear2d(axis = [1, 0], instances = sinkCount, distance = sinkSpacing)
|> extrude(length = 170)
tapNose = startSketchOn(offsetPlane(XZ, offset = 55 - tableDepth))
|> circle(%, center = [blockWidth / 2, tableHeight + 100], radius = 10)
|> patternLinear2d(axis = [1, 0], instances = sinkCount, distance = sinkSpacing)
|> extrude(length = sinkWidth / 2.5)
tapHandle = startSketchOn(offsetPlane(XZ, offset = 55 - tableDepth))
|> circle(%, center = [blockWidth / 2, tableHeight + 150], radius = 4)
|> patternLinear2d(axis = [1, 0], instances = sinkCount, distance = sinkSpacing)
|> extrude(length = 70)
// door panels
doorGap = 2
doorWidth = blockSubdivisionWidth - profileThickness - (doorGap * 2)
@ -160,6 +178,12 @@ doorBody = startProfile(doorPlane, at = [doorStart, 0])
|> close()
|> patternLinear2d(axis = [1, 0], instances = doorCount, distance = blockSubdivisionWidth)
|> extrude(length = doorHeight)
|> patternLinear3d(
%,
instances = 2,
distance = blockDepth,
axis = [0, 1, 0],
)
// side panels
panelWidth = blockDepth - profileThickness - (doorGap * 2)

View File

@ -50,3 +50,8 @@ test-group = "after-engine"
filter = "test(docs::gen_std_tests)"
test-group = "after-engine"
[profile.default.junit]
path = "../../../../test-results/junit.xml"
[profile.ci.junit]
path = "../../../../test-results/junit.xml"

View File

@ -53,7 +53,7 @@ redo-sim-tests:
test:
cargo install cargo-nextest
{{cnr}} --workspace --features artifact-graph --no-fail-fast
{{cnr}} --workspace --features=artifact-graph --no-fail-fast
bump-kcl-crate-versions bump='patch':
# First build the kcl-bumper tool.

View File

@ -2038,17 +2038,6 @@ async fn kcl_test_ensure_nothing_left_in_batch_multi_file() {
ctx.close().await;
}
#[tokio::test(flavor = "multi_thread")]
async fn kcl_test_default_param_for_unlabeled() {
let code = r#"fn myExtrude(@sk, len) {
return extrude(sk, length = len)
}
sketch001 = startSketchOn(XY)
|> circle(center = [0, 0], radius = 93.75)
|> myExtrude(len = 40)"#;
let _ = execute_and_snapshot(code, None).await.unwrap();
}
#[tokio::test(flavor = "multi_thread")]
async fn kcl_test_better_type_names() {

Some files were not shown because too many files have changed in this diff Show More