Files
modeling-app/docs/kcl/circle.md
Nick Cameron 5d25f4a0e5 Support types in the standard library (#5651)
* Parse an unparse type decls (and refactor impl attributes slightly)

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

* Remove special treatment of geometric types from parser and executor

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

* Generate docs for std types

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

* Hover tool-tips for types and fixup the frontend

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

* Fixes

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-07 09:53:34 -05:00

250 KiB

title, excerpt, layout
title excerpt layout
circle Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point. manual

Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.

circle(
  sketchOrSurface: SketchOrSurface,
  center: [number],
  radius: number,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
sketchOrSurface SketchOrSurface Plane or surface to sketch on. Yes
center [number] The center of the circle. Yes
radius number The radius of the circle. Yes
tag TagDeclarator Create a new tag which refers to this circle No

Returns

Sketch

Examples

exampleSketch = startSketchOn("-XZ")
  |> circle(center = [0, 0], radius = 10)

example = extrude(exampleSketch, length = 5)

Rendered example of circle 0

exampleSketch = startSketchOn("XZ")
  |> startProfileAt([-15, 0], %)
  |> line(end = [30, 0])
  |> line(end = [0, 30])
  |> line(end = [-30, 0])
  |> close()
  |> hole(circle(center = [0, 15], radius = 5), %)

example = extrude(exampleSketch, length = 5)

Rendered example of circle 1