Files
modeling-app/docs/kcl/circleThreePoint.md
49fl 474acb1c68 Add three point circle stdlib function (#4893)
* Add parsing keyword function calls inside pipelines

Co-authored-by: Adam Chalmers <adam.chalmers@zoo.dev>

* Add three point circle stdlib function

* Generate new documentation

* Fix 20:20 for the circle three point test

* Convert to using keyword arguments

* Wtf yo

* Remove unused structure

* Use the new simulation tests

* Regenerate documentation

---------

Co-authored-by: Jonathan Tran <jonnytran@gmail.com>
Co-authored-by: Adam Chalmers <adam.chalmers@zoo.dev>
2025-01-04 12:18:29 -05:00

84 KiB

title, excerpt, layout
title excerpt layout
circleThreePoint Construct a circle derived from 3 points. manual

Construct a circle derived from 3 points.

circleThreePoint(p1: [number], p2: [number], p3: [number], sketch_surface_or_group: SketchOrSurface, tag?: TagDeclarator) -> Sketch

Arguments

Name Type Description Required
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
sketch_surface_or_group SketchOrSurface Plane or surface to sketch on. Yes
tag TagDeclarator Identifier for the circle to reference elsewhere. No

Returns

Sketch - A sketch is a collection of paths.

Examples

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

example = extrude(5, exampleSketch)

Rendered example of circleThreePoint 0