52 lines
137 KiB
Markdown
52 lines
137 KiB
Markdown
---
|
|
title: "patternCircular3d"
|
|
excerpt: "Repeat a 3-dimensional solid some number of times along a partial or"
|
|
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 orentation of the solid with respect to the center of the circle is maintained.
|
|
|
|
```js
|
|
patternCircular3d(solid_set: SolidSet, instances: integer, axis: [number], center: [number], arc_degrees: number, rotate_duplicates: bool, use_original?: bool) -> [Solid]
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `solid_set` | [`SolidSet`](/docs/kcl/types/SolidSet) | Which solid(s) to pattern | Yes |
|
|
| `instances` | `integer` | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
|
|
| `axis` | `[number]` | The axis around which to make the pattern. This is a 3D vector | Yes |
|
|
| `center` | `[number]` | The center about which to make the pattern. This is a 3D vector. | Yes |
|
|
| `arc_degrees` | `number` | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
|
|
| `rotate_duplicates` | `bool` | Whether or not to rotate the duplicates as they are copied. | Yes |
|
|
| `use_original` | `bool` | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
|
|
|
|
### Returns
|
|
|
|
[`[Solid]`](/docs/kcl/types/Solid)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn('XZ')
|
|
|> circle({ center = [0, 0], radius = 1 }, %)
|
|
|
|
example = extrude(exampleSketch, length = -5)
|
|
|> patternCircular3d(
|
|
axis = [1, -1, 0],
|
|
center = [10, -20, 0],
|
|
instances = 11,
|
|
arcDegrees = 360,
|
|
rotateDuplicates = true,
|
|
)
|
|
```
|
|
|
|
|
|
|
|
|