Skip to main content

polygon()

Draws a regular polygon with the given number of sides and diameter.

Returns: Polygon

Signatures

polygon(numberOfSides: NumberParam, diameter: NumberParam, mode?: PolygonMode): Polygon

Draws a regular polygon with the given number of sides and diameter.

ParameterTypeDescription
numberOfSidesNumberParamThe number of sides
diameterNumberParamThe circumscribed or inscribed diameter
modePolygonMode'inscribed' or 'circumscribed' (defaults to 'inscribed') (optional)

polygon(center: Point2DLike, numberOfSides: NumberParam, diameter: NumberParam, mode?: PolygonMode): Polygon

Draws a regular polygon at a given center point.

ParameterTypeDescription
centerPoint2DLikeThe center point
numberOfSidesNumberParamThe number of sides
diameterNumberParamThe circumscribed or inscribed diameter
modePolygonMode'inscribed' or 'circumscribed' (defaults to 'inscribed') (optional)

polygon(targetPlane: SceneObject | PlaneLike, numberOfSides: NumberParam, diameter: NumberParam): Polygon

Draws a regular polygon on a specific plane.

ParameterTypeDescription
targetPlaneSceneObject | PlaneLikeThe plane to draw on
numberOfSidesNumberParamThe number of sides
diameterNumberParamThe circumscribed or inscribed diameter

polygon(targetPlane: SceneObject | PlaneLike, numberOfSides: NumberParam, diameter: NumberParam, mode: PolygonMode): Polygon

Draws a regular polygon with a given mode on a specific plane.

ParameterTypeDescription
targetPlaneSceneObject | PlaneLikeThe plane to draw on
numberOfSidesNumberParamThe number of sides
diameterNumberParamThe circumscribed or inscribed diameter
modePolygonMode'inscribed' or 'circumscribed'