Skip to content

Commit bedbf23

Browse files
Update KCL docs (#586)
YOYO NEW KCL DOCS!! Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 6022407 commit bedbf23

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

content/pages/docs/kcl-samples/helical-gear/main.kcl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ fn helicalGear(nTeeth, module, pressureAngle, helixAngle, gearHeight) {
4242
helicalGearSketch = startSketchOn(offsetPlane(XY, offset = offsetHeight))
4343
|> startProfile(at = polar(angle = helixCalc, length = baseDiameter / 2))
4444
|> involuteCircular(
45-
startRadius = baseDiameter / 2,
46-
endRadius = tipDiameter / 2,
45+
startDiameter = baseDiameter,
46+
endDiameter = tipDiameter,
4747
angle = helixCalc,
4848
tag = $seg01,
4949
)
5050
|> line(endAbsolute = polar(angle = 160 / nTeeth + helixCalc, length = tipDiameter / 2))
5151
|> involuteCircular(
52-
startRadius = baseDiameter / 2,
53-
endRadius = tipDiameter / 2,
52+
startDiameter = baseDiameter,
53+
endDiameter = tipDiameter,
5454
angle = -(4 * atan(segEndY(seg01) / segEndX(seg01)) - (3 * helixCalc)),
5555
reverse = true,
5656
)

content/pages/docs/kcl-std/functions/std-sketch-involuteCircular.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ Extend the current sketch with a new involute circular curve.
1010
```kcl
1111
involuteCircular(
1212
@sketch: Sketch,
13-
startRadius: number(Length),
14-
endRadius: number(Length),
1513
angle: number(Angle),
14+
startRadius?: number(Length),
15+
endRadius?: number(Length),
16+
startDiameter?: number(Length),
17+
endDiameter?: number(Length),
1618
reverse?: bool,
1719
tag?: TagDecl,
1820
): Sketch
@@ -25,9 +27,11 @@ involuteCircular(
2527
| Name | Type | Description | Required |
2628
|----------|------|-------------|----------|
2729
| `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 |
3030
| `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 |
3135
| `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 |
3236
| `tag` | [`TagDecl`](/docs/kcl-std/types/std-types-TagDecl) | Create a new tag which refers to this line. | No |
3337

0 commit comments

Comments
 (0)