Make the function signature less prominent, add an early example to docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-06-19 17:08:46 +12:00
parent 6358eed7e4
commit ff1be99351
99 changed files with 2137 additions and 686 deletions

View File

@ -8,19 +8,23 @@ layout: manual
Repeat a 3-dimensional solid some number of times along a partial or complete circle some specified number of times. Each object may additionally be rotated along the circle, ensuring orientation of the solid with respect to the center of the circle is maintained.
```kcl
patternCircular3d(
@solids: [Solid; 1+],
instances: number(_),
axis: Axis3d | Point3d,
center: Point3d,
arcDegrees?: number(deg),
rotateDuplicates?: bool,
useOriginal?: bool,
): [Solid; 1+]
// / Pattern using a named axis.
exampleSketch = startSketchOn(XZ)
|> circle(center = [0, 0], radius = 1)
example = extrude(exampleSketch, length = -5)
|> patternCircular3d(
axis = X,
center = [10, -20, 0],
instances = 11,
arcDegrees = 360,
rotateDuplicates = true,
)
```
### Arguments
| Name | Type | Description | Required |
@ -38,6 +42,20 @@ patternCircular3d(
[`[Solid; 1+]`](/docs/kcl-std/types/std-types-Solid)
### Function signature
```kcl
patternCircular3d(
@solids: [Solid; 1+],
instances: number(_),
axis: Axis3d | Point3d,
center: Point3d,
arcDegrees?: number(deg),
rotateDuplicates?: bool,
useOriginal?: bool,
): [Solid; 1+]
```
### Examples
```kcl