From f622815708a3a15b171e4532ba8715646cc619e1 Mon Sep 17 00:00:00 2001 From: gumyr Date: Fri, 1 Dec 2023 11:16:33 -0500 Subject: [PATCH] Clarifying Polygon docstring as discussed in PR #395 --- src/build123d/objects_sketch.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/build123d/objects_sketch.py b/src/build123d/objects_sketch.py index b9069099..4d5d977c 100644 --- a/src/build123d/objects_sketch.py +++ b/src/build123d/objects_sketch.py @@ -154,9 +154,14 @@ class Polygon(BaseSketchObject): Add polygon(s) defined by given sequence of points to sketch. + Note that the order of the points define the normal of the Face that is created in + Algebra mode, where counter clockwise order creates Faces with their normal being up + while a clockwise order will have a normal that is down. In Builder mode, all Faces + added to the sketch are up. + Args: pts (Union[VectorLike, Iterable[VectorLike]]): sequence of points defining the - vertices of polygon + vertices of the polygon rotation (float, optional): angles to rotate objects. Defaults to 0. align (Union[Align, tuple[Align, Align]], optional): align min, center, or max of object. Defaults to (Align.CENTER, Align.CENTER).