circleFunction in std::sketch
WARNING: This function is deprecated as of KCL 2.0.
Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.
This is part of sketch v1 and is deprecated. In KCL 2, create a
solver::circle inside a
sketch block, then select the
closed profile with region.
Legacy KCL 1 example: The next example uses deprecated subtract2d.
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. If not given, defaults to [0, 0]. | No |
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 | TagDecl | Create a new tag which refers to this circle. | No |
Returns
Sketch - A sketch is a collection of paths.