modeling-app/docs/kcl-std/polygon.md

title, excerpt, layout

title	excerpt	layout
std::sketch::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(
  @sketchSurfaceOrGroup: Sketch | Plane | Face,
  radius: number,
  numSides: u64,
  center: Point2d,
  inscribed?: bool,
): Sketch

Arguments

Name	Type	Description	Required
sketchSurfaceOrGroup	Sketch or Plane or Face	Plane or surface to sketch on	Yes
radius	number	The radius of the polygon	Yes
numSides	u64	The number of sides in the polygon	Yes
center	Point2d	The center point of the polygon	Yes
inscribed	bool	Whether the polygon is inscribed (true, the default) or circumscribed (false) about a circle with the specified radius	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)