Update docs
This commit is contained in:
16
docs/kcl-std/consts/std-cutStrategy-automatic.md
Normal file
16
docs/kcl-std/consts/std-cutStrategy-automatic.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: "cutStrategy::automatic"
|
||||
subtitle: "Constant in cutStrategy"
|
||||
excerpt: "Try the fast but simple Basic strategy, and if that fails, try the slow and complex CSG strategy."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
Try the fast but simple Basic strategy, and if that fails, try the slow and complex CSG strategy.
|
||||
|
||||
```kcl
|
||||
cutStrategy::automatic: string = "automatic"
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
16
docs/kcl-std/consts/std-cutStrategy-basic.md
Normal file
16
docs/kcl-std/consts/std-cutStrategy-basic.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: "cutStrategy::basic"
|
||||
subtitle: "Constant in cutStrategy"
|
||||
excerpt: "The basic strategy is fastest, but it can't handle complicated cases (like chamfering two edges that touch)."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
The basic strategy is fastest, but it can't handle complicated cases (like chamfering two edges that touch).
|
||||
|
||||
```kcl
|
||||
cutStrategy::basic: string = "basic"
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
16
docs/kcl-std/consts/std-cutStrategy-csg.md
Normal file
16
docs/kcl-std/consts/std-cutStrategy-csg.md
Normal file
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: "cutStrategy::csg"
|
||||
subtitle: "Constant in cutStrategy"
|
||||
excerpt: "The CSG strategy is slowest, but it can handle complex cases (like chamfering two edges that touch)."
|
||||
layout: manual
|
||||
---
|
||||
|
||||
The CSG strategy is slowest, but it can handle complex cases (like chamfering two edges that touch).
|
||||
|
||||
```kcl
|
||||
cutStrategy::csg: string = "csg"
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
@ -14,6 +14,7 @@ fillet(
|
||||
tags: [Edge; 1+],
|
||||
tolerance?: number(Length),
|
||||
tag?: tag,
|
||||
strategy?: string,
|
||||
): Solid
|
||||
```
|
||||
|
||||
@ -30,6 +31,7 @@ will smoothly blend the transition.
|
||||
| `tags` | [`[Edge; 1+]`](/docs/kcl-std/types/std-types-Edge) | The paths you want to fillet | Yes |
|
||||
| `tolerance` | `number(Length)` | The tolerance for this fillet | No |
|
||||
| [`tag`](/docs/kcl-std/types/std-types-tag) | [`tag`](/docs/kcl-std/types/std-types-tag) | Create a new tag which refers to this fillet | No |
|
||||
| `strategy` | [`string`](/docs/kcl-std/types/std-types-string) | Which strategy should be used to perform this chamfer? | No |
|
||||
|
||||
### Returns
|
||||
|
||||
|
@ -124,6 +124,10 @@ layout: manual
|
||||
* [`Y`](/docs/kcl-std/consts/std-Y)
|
||||
* [`YZ`](/docs/kcl-std/consts/std-YZ)
|
||||
* [`Z`](/docs/kcl-std/consts/std-Z)
|
||||
* [**std::cutStrategy**](/docs/kcl-std/modules/std-cutStrategy)
|
||||
* [`cutStrategy::automatic`](/docs/kcl-std/consts/std-cutStrategy-automatic)
|
||||
* [`cutStrategy::basic`](/docs/kcl-std/consts/std-cutStrategy-basic)
|
||||
* [`cutStrategy::csg`](/docs/kcl-std/consts/std-cutStrategy-csg)
|
||||
* [**std::math**](/docs/kcl-std/modules/std-math)
|
||||
* [`E`](/docs/kcl-std/consts/std-math-E)
|
||||
* [`PI`](/docs/kcl-std/consts/std-math-PI)
|
||||
|
18
docs/kcl-std/modules/std-cutStrategy.md
Normal file
18
docs/kcl-std/modules/std-cutStrategy.md
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
title: "cutStrategy"
|
||||
subtitle: "Module in std"
|
||||
excerpt: ""
|
||||
layout: manual
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Functions and constants
|
||||
|
||||
* [`cutStrategy::automatic`](/docs/kcl-std/consts/std-cutStrategy-automatic)
|
||||
* [`cutStrategy::basic`](/docs/kcl-std/consts/std-cutStrategy-basic)
|
||||
* [`cutStrategy::csg`](/docs/kcl-std/consts/std-cutStrategy-csg)
|
||||
|
@ -12,6 +12,7 @@ Contains frequently used constants, functions for interacting with the KittyCAD
|
||||
## Modules
|
||||
|
||||
* [`array`](/docs/kcl-std/modules/std-array)
|
||||
* [`cutStrategy::cutStrategy`](/docs/kcl-std/modules/std-cutStrategy)
|
||||
* [`math`](/docs/kcl-std/modules/std-math)
|
||||
* [`sketch`](/docs/kcl-std/modules/std-sketch)
|
||||
* [`solid`](/docs/kcl-std/modules/std-solid)
|
||||
|
Reference in New Issue
Block a user