3b2abe5814
* Support calling KCL std KW fns, and move circle to KCL std Signed-off-by: Nick Cameron <nrc@ncameron.org> * Doc comments on parameters Signed-off-by: Nick Cameron <nrc@ncameron.org> * Update grammar Signed-off-by: Nick Cameron <nrc@ncameron.org> * Change use of counterClockWise to ccw Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
250 KiB
250 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| std::sketch::circle | manual |
Construct a 2-dimensional circle, of the specified radius, centered atthe provided (x, y) origin point.
circle(@sketch_or_surface: Sketch | Plane | Face, center: Point2d, radius: number, tag?: tag): Sketch
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
sketch_or_surface |
Sketch ` |
[Plane](/docs/kcl/types/Face) |
[Plane`](/docs/kcl/types/Face) |
center |
Point2d |
The center of the circle. | Yes |
radius |
number |
The radius of the circle. | Yes |
tag |
tag |
Create a new tag which refers to this circle. | No |
Returns
Examples
exampleSketch = startSketchOn(-XZ)
|> circle(center = [0, 0], radius = 10)
example = extrude(exampleSketch, length = 5)
exampleSketch = startSketchOn(XZ)
|> startProfileAt([-15, 0], %)
|> line(end = [30, 0])
|> line(end = [0, 30])
|> line(end = [-30, 0])
|> close()
|> hole(circle(center = [0, 15], radius = 5), %)
example = extrude(exampleSketch, length = 5)