From 4ce2e481e51c3f851b36d936cb89275f3a6eea1b Mon Sep 17 00:00:00 2001 From: vocx-fc Date: Wed, 7 Aug 2019 11:27:57 -0500 Subject: [PATCH] Draft: WorkingPlane, Pythonic style, docstring of the plane class --- src/Mod/Draft/WorkingPlane.py | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/Mod/Draft/WorkingPlane.py b/src/Mod/Draft/WorkingPlane.py index ddabe79552..4491895d38 100644 --- a/src/Mod/Draft/WorkingPlane.py +++ b/src/Mod/Draft/WorkingPlane.py @@ -44,7 +44,27 @@ __url__ = "http://www.freecadweb.org" class plane: - '''A WorkPlane object''' + """A WorkPlane object. + + Attributes + ---------- + doc : App::Document + The active document. Reset view when `doc` changes. + weak : bool + It is `True` if the plane has been defined by `setup()` + or has been reset. + u : Base::Vector3 + A vector that helps define the working plane. + v : Base::Vector3 + A vector that helps define the working plane. + axis : Base::Vector3 + A vector that is supposed to be perpendicular to `u` and `v`; + it is helpful although redundant. + position : Base::Vector3 + A vector that helps define the working plane. + stored : bool + A placeholder for a stored state. + """ def __init__(self, u=Vector(1, 0, 0), v=Vector(0, 1, 0), w=Vector(0, 0, 1), pos=Vector(0, 0, 0)): # keep track of active document. Reset view when doc changes.