From f6f43b6fe4e8a1621d7b4cc767b89be2b9675369 Mon Sep 17 00:00:00 2001 From: j <77419450+emmanuelobrien@users.noreply.github.com> Date: Wed, 3 Feb 2021 15:12:40 +0100 Subject: [PATCH] Sketcher: Constraint documentation --- src/Mod/Sketcher/App/Constraint.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Mod/Sketcher/App/Constraint.h b/src/Mod/Sketcher/App/Constraint.h index 7a3316b08a..6e526030cc 100644 --- a/src/Mod/Sketcher/App/Constraint.h +++ b/src/Mod/Sketcher/App/Constraint.h @@ -75,7 +75,13 @@ enum InternalAlignmentType { BSplineKnotPoint = 10, }; -/// define if you want to use the end or start point +/*! PointPos lets us refer to different aspects of a piece of geometry. sketcher::none refers + * to an edge itself (eg., for a Perpendicular constraint on two lines). sketcher::start and + * sketcher::end denote the endpoints of lines or bounded curves. sketcher::mid denotes + * geometries with geometrical centers (eg., circle, ellipse). Bare points use 'start'. More + * complex geometries like parabola focus or b-spline knots use InternalAlignment constraints + * in addition to PointPos. + */ enum PointPos { none, start, end, mid }; class SketcherExport Constraint : public Base::Persistence