modeling-app/docs/kcl-std/functions/std-sketch-circle.md

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

Examples

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

example = extrude(exampleSketch, length = 5)

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)