Files
modeling-app/docs/kcl/polygon.md
49fl 7103ded32a Guptaarnav 2024 10 28 (#4341)
* accessing toast error correctly

* wrapping try-catch around fs.stat on cli arg

* implemented array push

* changing arg execution order for sketch arc

* addressing sketchFromKclValue error for Sketches in Uservals

* addressing 'update to He inside a test not wrapped in act(...' error

* yarn fmt fix

* implemented polygon stdlib function

* changing polygon inscribed arg description in docs

* addressing cargo clippy warning

* Add tangential arc unavailable reason tooltip

* fixing tsc errors

* preventing hidden dirs from showing up as projects and prohibits renaming projects as hidden

* adding unit test for desktop listProjects

* showing no completions when last typed word is a number

* fmt

* Make clippy happy

* A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest)

* yarn tsc fix: added missing toast import in Home.tsx

* A snapshot a day keeps the bugs away! 📷🐛 (OS: windows-latest)

* regenerating markdown docs for incoming merge from main

---------

Co-authored-by: arnav <arnav@agupta.org>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-10-28 20:52:51 -04:00

130 KiB

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, sketch_surface_or_group: SketchOrSurface, tag?: TagDeclarator) -> Sketch

Arguments

Name Type Description Required
data PolygonData Data for drawing a polygon Yes
sketch_surface_or_group 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(5, hex)

Rendered example of polygon 0

// 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(5, square)

Rendered example of polygon 1