kcl-std → functions → ellipse

ellipseFunction in std::sketch

Construct a 2-dimensional ellipse, of the specified major/minor radius, centered at the provided (x, y) point.

ellipse(
  @sketchOrSurface: Sketch | Plane | Face,
  center: Point2d,
  majorRadius: number(Length),
  minorRadius: number(Length),
  tag?: tag,
): Sketch

Arguments

NameTypeDescriptionRequired
sketchOrSurfaceSketch or Plane or FaceSketch to extend, or plane or surface to sketch on.Yes
centerPoint2dThe center of the ellipse.Yes
majorRadiusnumber(Length)The major radius of the ellipse.Yes
minorRadiusnumber(Length)The minor radius of the ellipse.Yes
tagtagCreate a new tag which refers to this ellipse.No

Returns

Sketch - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn(XY)
  |> ellipse(center = [0, 0], majorRadius = 50, minorRadius = 20)

Rendered example of ellipse 0

Found a typo?