KCL: Default circular pattern rotateDuplicates=true, arcDegrees=360 (#7052)

KCL: Default circular pattern rotateDuplicates=true, arcDeg=360

Seems like most users would want these.
This commit is contained in:
Adam Chalmers
2025-05-18 21:46:00 -05:00
committed by GitHub
parent 658497da1d
commit f3e9d110c0
5 changed files with 47 additions and 47 deletions

View File

@ -12,8 +12,8 @@ patternCircular2d(
@sketchSet: [Sketch],
instances: number,
center: Point2d,
arcDegrees: number,
rotateDuplicates: bool,
arcDegrees?: number,
rotateDuplicates?: bool,
useOriginal?: bool,
): [Sketch]
```
@ -27,8 +27,8 @@ patternCircular2d(
| `sketchSet` | [`[Sketch]`](/docs/kcl-std/types/std-types-Sketch) | Which sketch(es) to pattern | Yes |
| `instances` | [`number`](/docs/kcl-std/types/std-types-number) | 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 |
| `center` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The center about which to make the pattern. This is a 2D vector. | Yes |
| `arcDegrees` | [`number`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. | Yes |
| `arcDegrees` | [`number`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. Defaults to 360. | No |
| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. Defaults to true. | No |
| `useOriginal` | [`bool`](/docs/kcl-std/types/std-types-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

View File

@ -13,8 +13,8 @@ patternCircular3d(
instances: number,
axis: [number],
center: Point3d,
arcDegrees: number,
rotateDuplicates: bool,
arcDegrees?: number,
rotateDuplicates?: bool,
useOriginal?: bool,
): [Solid]
```
@ -29,8 +29,8 @@ patternCircular3d(
| `instances` | [`number`](/docs/kcl-std/types/std-types-number) | 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]`](/docs/kcl-std/types/std-types-number) | The axis around which to make the pattern. This is a 3D vector | Yes |
| `center` | [`Point3d`](/docs/kcl-std/types/std-types-Point3d) | The center about which to make the pattern. This is a 3D vector. | Yes |
| `arcDegrees` | [`number`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. | Yes |
| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. | Yes |
| `arcDegrees` | [`number`](/docs/kcl-std/types/std-types-number) | The arc angle (in degrees) to place the repetitions. Must be greater than 0. Defaults to 360. | No |
| `rotateDuplicates` | [`bool`](/docs/kcl-std/types/std-types-bool) | Whether or not to rotate the duplicates as they are copied. Defaults to true. | No |
| `useOriginal` | [`bool`](/docs/kcl-std/types/std-types-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

View File

@ -127364,9 +127364,10 @@
"type": "number",
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "double",
"title": "Nullable_double",
"type": "number",
"format": "double",
"nullable": true,
"definitions": {
"Sketch": {
"type": "object",
@ -128959,9 +128960,8 @@
}
}
},
"required": true,
"includeInSnippet": true,
"description": "The arc angle (in degrees) to place the repetitions. Must be greater than 0.",
"required": false,
"description": "The arc angle (in degrees) to place the repetitions. Must be greater than 0. Defaults to 360.",
"labelRequired": true
},
{
@ -128969,8 +128969,9 @@
"type": "bool",
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "Boolean",
"title": "Nullable_Boolean",
"type": "boolean",
"nullable": true,
"definitions": {
"Sketch": {
"type": "object",
@ -130563,9 +130564,8 @@
}
}
},
"required": true,
"includeInSnippet": true,
"description": "Whether or not to rotate the duplicates as they are copied.",
"required": false,
"description": "Whether or not to rotate the duplicates as they are copied. Defaults to true.",
"labelRequired": true
},
{
@ -140234,9 +140234,10 @@
"type": "number",
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "double",
"title": "Nullable_double",
"type": "number",
"format": "double",
"nullable": true,
"definitions": {
"Solid": {
"type": "object",
@ -141829,9 +141830,8 @@
}
}
},
"required": true,
"includeInSnippet": true,
"description": "The arc angle (in degrees) to place the repetitions. Must be greater than 0.",
"required": false,
"description": "The arc angle (in degrees) to place the repetitions. Must be greater than 0. Defaults to 360.",
"labelRequired": true
},
{
@ -141839,8 +141839,9 @@
"type": "bool",
"schema": {
"$schema": "https://spec.openapis.org/oas/3.0/schema/2019-04-02#/definitions/Schema",
"title": "Boolean",
"title": "Nullable_Boolean",
"type": "boolean",
"nullable": true,
"definitions": {
"Solid": {
"type": "object",
@ -143433,9 +143434,8 @@
}
}
},
"required": true,
"includeInSnippet": true,
"description": "Whether or not to rotate the duplicates as they are copied.",
"required": false,
"description": "Whether or not to rotate the duplicates as they are copied. Defaults to true.",
"labelRequired": true
},
{