diff --git a/docs/kcl-std/consts/std-cutStrategy-automatic.md b/docs/kcl-std/consts/std-cutStrategy-automatic.md new file mode 100644 index 000000000..c1a9d6834 --- /dev/null +++ b/docs/kcl-std/consts/std-cutStrategy-automatic.md @@ -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" +``` + + + + diff --git a/docs/kcl-std/consts/std-cutStrategy-basic.md b/docs/kcl-std/consts/std-cutStrategy-basic.md new file mode 100644 index 000000000..b8683148e --- /dev/null +++ b/docs/kcl-std/consts/std-cutStrategy-basic.md @@ -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" +``` + + + + diff --git a/docs/kcl-std/consts/std-cutStrategy-csg.md b/docs/kcl-std/consts/std-cutStrategy-csg.md new file mode 100644 index 000000000..cfa65fad0 --- /dev/null +++ b/docs/kcl-std/consts/std-cutStrategy-csg.md @@ -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" +``` + + + + diff --git a/docs/kcl-std/functions/std-solid-fillet.md b/docs/kcl-std/functions/std-solid-fillet.md index e4116cd04..70a5838af 100644 --- a/docs/kcl-std/functions/std-solid-fillet.md +++ b/docs/kcl-std/functions/std-solid-fillet.md @@ -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 diff --git a/docs/kcl-std/index.md b/docs/kcl-std/index.md index ddee94154..5a2ee2025 100644 --- a/docs/kcl-std/index.md +++ b/docs/kcl-std/index.md @@ -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) diff --git a/docs/kcl-std/modules/std-cutStrategy.md b/docs/kcl-std/modules/std-cutStrategy.md new file mode 100644 index 000000000..566db08fa --- /dev/null +++ b/docs/kcl-std/modules/std-cutStrategy.md @@ -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) + diff --git a/docs/kcl-std/modules/std.md b/docs/kcl-std/modules/std.md index b75ac3b9f..b349a8483 100644 --- a/docs/kcl-std/modules/std.md +++ b/docs/kcl-std/modules/std.md @@ -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)