KCL: involuteCircular can use diameter in addition to radius (#7519)
Mechanical engineers prefer using diameter over radius.
This commit is contained in:
		@ -10,9 +10,11 @@ Extend the current sketch with a new involute circular curve.
 | 
			
		||||
```kcl
 | 
			
		||||
involuteCircular(
 | 
			
		||||
  @sketch: Sketch,
 | 
			
		||||
  startRadius: number(Length),
 | 
			
		||||
  endRadius: number(Length),
 | 
			
		||||
  angle: number(Angle),
 | 
			
		||||
  startRadius?: number(Length),
 | 
			
		||||
  endRadius?: number(Length),
 | 
			
		||||
  startDiameter?: number(Length),
 | 
			
		||||
  endDiameter?: number(Length),
 | 
			
		||||
  reverse?: bool,
 | 
			
		||||
  tag?: TagDecl,
 | 
			
		||||
): Sketch
 | 
			
		||||
@ -25,9 +27,11 @@ involuteCircular(
 | 
			
		||||
| Name | Type | Description | Required |
 | 
			
		||||
|----------|------|-------------|----------|
 | 
			
		||||
| `sketch` | [`Sketch`](/docs/kcl-std/types/std-types-Sketch) | Which sketch should this path be added to? | Yes |
 | 
			
		||||
| `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 |
 | 
			
		||||
| `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 |
 | 
			
		||||
| `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 |
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user