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

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
polygon	Function in std::sketch	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.

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

Arguments

Name	Type	Description	Required
sketchOrSurface	Sketch or Plane or Face	Plane or surface to sketch on.	Yes
radius	number(Length)	The radius of the polygon.	Yes
numSides	number(_)	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.

Function signature

polygon(
  @sketchOrSurface: Sketch | Plane | Face,
  radius: number(Length),
  numSides: number(_),
  center: Point2d,
  inscribed?: bool,
): Sketch

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)