f8ca6ad746
* Change polygon to keyword args * Update docs * Update generated output * Update docs to mention the default for inscribed * Appease clippy * Remove tag parameter * Update docs since removing tag * Remove inscribed from autocomplete snippet since the default is true
69 lines
136 KiB
Markdown
69 lines
136 KiB
Markdown
---
|
|
title: "polygon"
|
|
excerpt: "Create a regular polygon with the specified number of sides that is either inscribed or circumscribed around a circle of the specified radius."
|
|
layout: manual
|
|
---
|
|
|
|
Create a regular polygon with the specified number of sides that is either inscribed or circumscribed around a circle of the specified radius.
|
|
|
|
|
|
|
|
```js
|
|
polygon(
|
|
sketchSurfaceOrGroup: SketchOrSurface,
|
|
radius: number,
|
|
numSides: u64,
|
|
center: [number],
|
|
inscribed?: bool,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketchSurfaceOrGroup` | [`SketchOrSurface`](/docs/kcl/types/SketchOrSurface) | Plane or surface to sketch on | Yes |
|
|
| `radius` | [`number`](/docs/kcl/types/number) | The radius of the polygon | Yes |
|
|
| `numSides` | `u64` | The number of sides in the polygon | Yes |
|
|
| `center` | [`[number]`](/docs/kcl/types/number) | The center point of the polygon | Yes |
|
|
| `inscribed` | [`bool`](/docs/kcl/types/bool) | Whether the polygon is inscribed (true, the default) or circumscribed (false) about a circle with the specified radius | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
// Create a regular hexagon inscribed in a circle of radius 10
|
|
hex = startSketchOn(XY)
|
|
|> polygon(
|
|
radius = 10,
|
|
numSides = 6,
|
|
center = [0, 0],
|
|
inscribed = true,
|
|
)
|
|
|
|
example = extrude(hex, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// Create a square circumscribed around a circle of radius 5
|
|
square = startSketchOn(XY)
|
|
|> polygon(
|
|
radius = 5.0,
|
|
numSides = 4,
|
|
center = [10, 10],
|
|
inscribed = false,
|
|
)
|
|
example = extrude(square, length = 5)
|
|
```
|
|
|
|
|
|
|
|
|