63 lines
40 KiB
Markdown
63 lines
40 KiB
Markdown
---
|
|
title: "involuteCircular"
|
|
subtitle: "Function in std::sketch"
|
|
excerpt: "Extend the current sketch with a new involute circular curve."
|
|
layout: manual
|
|
---
|
|
|
|
Extend the current sketch with a new involute circular curve.
|
|
|
|
```kcl
|
|
involuteCircular(
|
|
@sketch: Sketch,
|
|
angle: number(Angle),
|
|
startRadius?: number(Length),
|
|
endRadius?: number(Length),
|
|
startDiameter?: number(Length),
|
|
endDiameter?: number(Length),
|
|
reverse?: bool,
|
|
tag?: TagDecl,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes |
|
|
| `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 |
|
|
| `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 |
|
|
| `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 |
|
|
| `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 |
|
|
| `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 |
|
|
| `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 |
|
|
| `tag` | [`TagDecl`](/docs/kcl-std/types/std-types-TagDecl) | Create a new tag which refers to this line. | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl-std/types/std-types-Sketch) - A sketch is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
a = 10
|
|
b = 14
|
|
startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> involuteCircular(startRadius = a, endRadius = b, angle = 60deg)
|
|
|> involuteCircular(
|
|
startRadius = a,
|
|
endRadius = b,
|
|
angle = 60deg,
|
|
reverse = true,
|
|
)
|
|
|
|
```
|
|
|
|
|
|
|
|
|