Files
modeling-app/docs/kcl/circleThreePoint.md
Nick Cameron 3b2abe5814 Declare std kwarg functions in KCL and migrate circle (#5955)
* Support calling KCL std KW fns, and move circle to KCL std

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Doc comments on parameters

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Update grammar

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* Change use of counterClockWise to ccw

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-24 21:55:24 +13:00

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: SketchOrSurface,
  p1: [number],
  p2: [number],
  p3: [number],
  tag?: TagDeclarator,
): 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

Sketch

Examples

exampleSketch = startSketchOn(XY)
  |> circleThreePoint(p1 = [10, 10], p2 = [20, 8], p3 = [15, 5])
  |> extrude(length = 5)

Rendered example of circleThreePoint 0