Files
modeling-app/docs/kcl-std/functions/std-sketch-circle.md
Nick Cameron 80e3dc9095 Move more functions to KCL decls (#7266)
* Move some sketch functions to KCL

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

* Move asserts to KCL

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

* sweep, loft -> KCL

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

* Move pattern transforms to KCL

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-29 19:00:16 -04:00

250 KiB

title, subtitle, excerpt, layout
title subtitle excerpt layout
circle Function in std::sketch manual
circle(
  @sketchOrSurface: Sketch | Plane | Face,
  center: Point2d,
  radius?: number(Length),
  diameter?: number(Length),
  tag?: tag,
): Sketch

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

Arguments

Name Type Description Required
sketchOrSurface Sketch or Plane or Face Sketch to extend, or plane or surface to sketch on. Yes
center Point2d The center of the circle. Yes
radius number(Length) The radius of the circle. Incompatible with diameter. No
diameter number(Length) The diameter of the circle. Incompatible with radius. No
tag tag Create a new tag which refers to this circle. No

Returns

Sketch - A sketch is a collection of paths.

Examples

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

example = extrude(exampleSketch, length = 5)

Rendered example of circle 0

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [-15, 0])
  |> line(end = [30, 0])
  |> line(end = [0, 30])
  |> line(end = [-30, 0])
  |> close()
  |> subtract2d(tool = circle(center = [0, 15], diameter = 10))

example = extrude(exampleSketch, length = 5)

Rendered example of circle 1