c050739f41
* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
62 lines
250 KiB
Markdown
62 lines
250 KiB
Markdown
---
|
|
title: "std::sketch::circle"
|
|
excerpt: ""
|
|
layout: manual
|
|
---
|
|
|
|
|
|
|
|
Construct a 2-dimensional circle, of the specified radius, centered at
|
|
the provided (x, y) origin point.
|
|
|
|
```kcl
|
|
circle(
|
|
@sketch_or_surface: [Sketch](/docs/kcl/types/Sketch) | [Plane](/docs/kcl/types/Plane) | [Face](/docs/kcl/types/Face),
|
|
center: [Point2d](/docs/kcl/types/Point2d),
|
|
radius: [number](/docs/kcl/types/number)(Length),
|
|
tag?: tag,
|
|
): [Sketch](/docs/kcl/types/Sketch)
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch_or_surface` | [`Sketch`](/docs/kcl/types/Sketch) or [`Plane`](/docs/kcl/types/Plane) or [`Face`](/docs/kcl/types/Face) | Sketch to extend, or plane or surface to sketch on. | Yes |
|
|
| `center` | [`Point2d`](/docs/kcl/types/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`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
exampleSketch = startSketchOn(-XZ)
|
|
|> circle(center = [0, 0], radius = 10)
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```kcl
|
|
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)
|
|
```
|
|
|
|
|
|
|
|
|