polygon()
Draws a regular polygon with the given number of sides and diameter.
Returns: Polygon
Signatures
polygon(numberOfSides: number, diameter: number, mode?: PolygonMode): Polygon
Draws a regular polygon with the given number of sides and diameter.
| Parameter | Type | Description |
|---|---|---|
numberOfSides | number | The number of sides |
diameter | number | The circumscribed or inscribed diameter |
mode | PolygonMode | 'inscribed' or 'circumscribed' (defaults to 'inscribed') (optional) |
polygon(center: Point2DLike, numberOfSides: number, diameter: number, mode?: PolygonMode): Polygon
Draws a regular polygon at a given center point.
| Parameter | Type | Description |
|---|---|---|
center | Point2DLike | The center point |
numberOfSides | number | The number of sides |
diameter | number | The circumscribed or inscribed diameter |
mode | PolygonMode | 'inscribed' or 'circumscribed' (defaults to 'inscribed') (optional) |
polygon(targetPlane: SceneObject | PlaneLike, numberOfSides: number, diameter: number): Polygon
Draws a regular polygon on a specific plane.
| Parameter | Type | Description |
|---|---|---|
targetPlane | SceneObject | PlaneLike | The plane to draw on |
numberOfSides | number | The number of sides |
diameter | number | The circumscribed or inscribed diameter |
polygon(targetPlane: SceneObject | PlaneLike, numberOfSides: number, diameter: number, mode: PolygonMode): Polygon
Draws a regular polygon with a given mode on a specific plane.
| Parameter | Type | Description |
|---|---|---|
targetPlane | SceneObject | PlaneLike | The plane to draw on |
numberOfSides | number | The number of sides |
diameter | number | The circumscribed or inscribed diameter |
mode | PolygonMode | 'inscribed' or 'circumscribed' |