5d25f4a0e5
* Parse an unparse type decls (and refactor impl attributes slightly) Signed-off-by: Nick Cameron <nrc@ncameron.org> * Remove special treatment of geometric types from parser and executor Signed-off-by: Nick Cameron <nrc@ncameron.org> * Generate docs for std types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Hover tool-tips for types and fixup the frontend Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fixes Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
61 lines
250 KiB
Markdown
61 lines
250 KiB
Markdown
---
|
|
title: "circle"
|
|
excerpt: "Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point."
|
|
layout: manual
|
|
---
|
|
|
|
Construct a 2-dimensional circle, of the specified radius, centered at the provided (x, y) origin point.
|
|
|
|
|
|
|
|
```js
|
|
circle(
|
|
sketchOrSurface: SketchOrSurface,
|
|
center: [number],
|
|
radius: number,
|
|
tag?: TagDeclarator,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketchOrSurface` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | Plane or surface to sketch on. | Yes |
|
|
| `center` | [`[number]`](/docs/kcl/types/number) | The center of the circle. | Yes |
|
|
| `radius` | [`number`](/docs/kcl/types/number) | The radius of the circle. | Yes |
|
|
| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this circle | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn("-XZ")
|
|
|> circle(center = [0, 0], radius = 10)
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
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)
|
|
```
|
|
|
|
|
|
|
|
|