You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/pages/docs/kcl-std/functions/std-sketch-involuteCircular.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,11 @@ Extend the current sketch with a new involute circular curve.
10
10
```kcl
11
11
involuteCircular(
12
12
@sketch: Sketch,
13
-
startRadius: number(Length),
14
-
endRadius: number(Length),
15
13
angle: number(Angle),
14
+
startRadius?: number(Length),
15
+
endRadius?: number(Length),
16
+
startDiameter?: number(Length),
17
+
endDiameter?: number(Length),
16
18
reverse?: bool,
17
19
tag?: TagDecl,
18
20
): Sketch
@@ -25,9 +27,11 @@ involuteCircular(
25
27
| Name | Type | Description | Required |
26
28
|----------|------|-------------|----------|
27
29
|`sketch`|[`Sketch`](/docs/kcl-std/types/std-types-Sketch)| Which sketch should this path be added to? | Yes |
28
-
|`startRadius`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, start_radius is the radius of the inner circle. | Yes |
29
-
|`endRadius`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, end_radius is the radius of the outer circle. | Yes |
30
30
|`angle`|[`number(Angle)`](/docs/kcl-std/types/std-types-number)| The angle to rotate the involute by. A value of zero will produce a curve with a tangent along the x-axis at the start point of the curve. | Yes |
31
+
|`startRadius`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, startRadius is the radius of the inner circle. Either `startRadius` or `startDiameter` must be given (but not both). | No |
32
+
|`endRadius`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, endRadius is the radius of the outer circle. Either `endRadius` or `endDiameter` must be given (but not both). | No |
33
+
|`startDiameter`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, startDiameter describes the inner circle. Either `startRadius` or `startDiameter` must be given (but not both). | No |
34
+
|`endDiameter`|[`number(Length)`](/docs/kcl-std/types/std-types-number)| The involute is described between two circles, endDiameter describes the outer circle. Either `endRadius` or `endDiameter` must be given (but not both). | No |
31
35
|`reverse`|[`bool`](/docs/kcl-std/types/std-types-bool)| If reverse is true, the segment will start from the end of the involute, otherwise it will start from that start. | No |
32
36
|`tag`|[`TagDecl`](/docs/kcl-std/types/std-types-TagDecl)| Create a new tag which refers to this line. | No |
0 commit comments