c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
87 KiB
87 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| circleThreePoint | Construct a circle derived from 3 points. | manual |
Construct a circle derived from 3 points.
circleThreePoint(
sketchSurfaceOrGroup: [[Sketch](/docs/kcl/types/Sketch)OrSurface](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)OrSurface),
p1: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
p2: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
p3: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
): [Sketch](/docs/kcl/types/Sketch)
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
sketchSurfaceOrGroup |
SketchOrSurface |
Plane or surface to sketch on. | Yes |
p1 |
[number] |
1st point to derive the circle. | Yes |
p2 |
[number] |
2nd point to derive the circle. | Yes |
p3 |
[number] |
3rd point to derive the circle. | Yes |
tag |
TagDeclarator |
Identifier for the circle to reference elsewhere. | No |
Returns
Examples
exampleSketch = startSketchOn(XY)
|> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
|> extrude(length = 5)