Files
modeling-app/docs/kcl-std/functions/std-sketch-circle.md
Nick Cameron 1841e63021 Misc docs polishing (#6712)
* Fake modules for Rust std lib functions

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

* Include the missing @ in Rust std lib fns

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

* Move revolve and mirror2d to better modules

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

* Use docs from KCL mods for type summaries

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

* Use type docs to describe types from KCL std lib

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 16:09:59 +12:00

250 KiB

title, excerpt, layout
title excerpt layout
std::sketch::circle manual

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

circle(
  @sketch_or_surface: Sketch | Plane | Face,
  center: Point2d,
  radius: number(Length),
  tag?: tag,
): Sketch

Arguments

Name Type Description Required
sketch_or_surface 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. Yes
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 std::sketch::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], radius = 5))

example = extrude(exampleSketch, length = 5)

Rendered example of std::sketch::circle 1