kcl-stdfunctionscircle

circleFunction in std::sketch

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

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

Arguments

NameTypeDescriptionRequired
sketchOrSurfaceSketch or Plane or FaceSketch to extend, or plane or surface to sketch on.Yes
centerPoint2dThe center of the circle.Yes
radiusnumber(Length)The radius of the circle. Incompatible with diameter.No
diameternumber(Length)The diameter of the circle. Incompatible with radius.No
tagTagDeclCreate 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

Found a typo?