modeling-app/docs/kcl/polygon.md

title, excerpt, layout

title	excerpt	layout
polygon	Create a regular polygon with the specified number of sides that is either inscribed or circumscribed around a circle of the specified radius.	manual

Create a regular polygon with the specified number of sides that is either inscribed or circumscribed around a circle of the specified radius.

polygon(
  data: PolygonData,
  sketchSurfaceOrGroup: SketchOrSurface,
  tag?: TagDeclarator,
): Sketch

Arguments

Name	Type	Description	Required
data	PolygonData	Data for drawing a polygon	Yes
sketchSurfaceOrGroup	SketchOrSurface	A sketch surface or a sketch.	Yes
tag	TagDeclarator		No

Returns

Sketch - A sketch is a collection of paths.

Examples

// 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)

// 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)