Sketcher ConstrainCoincident

From FreeCAD Documentation
Revision as of 14:12, 17 October 2020 by Jmaustpc (talk | contribs) (explained why vertices are numbered from 1 and not 0.)
Jump to navigation Jump to search
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎русский

Sketcher ConstrainCoincident.svg Sketcher ConstrainCoincident

Menu location
Sketch → Sketcher constraints → Constrain coincident
Default shortcut
Introduced in version
See also
Constrain Lock, Constrain Point onto Object


Create a coincident constraint on the selected item

This constraint tool takes two points as its argument and serves to make the two points coincident. (Meaning to make them as-one-point).

In practical terms this constraint tool is useful when there is a break in a profile for example - where two lines end near each other and need to be joined - a coincident constraint on their end-points will close the gap.


As stated above, this tool takes two arguments - both are points.

  1. First, it is necessary to highlight two distinct points. (Note: this will not work if, for example, you attempt to select the start and end point of the same line).
  2. Highlighting of a drawing item is achieved by moving the mouse over the item and clicking the left-mouse-button.
  3. A highlighted item will change its color to green. (This color can be customized in Editing → Preference → Display → Colors → Selection)
  4. Subsequent items can be highlighted by repeating the above procedure(s). Note: it's unnecessary to hold-down any special key like Ctrl to achieve multiple item selection in a drawing.
  5. Once you have two points highlighted, you can invoke the command using several methods:
    • Pressing on the Sketcher ConstrainCoincident.svg Coinstrain coincident constraint button in the toolbar.
    • Using the C keyboard shortcut.
    • Using the Sketch → Sketcher constraints → Constrain coincident entry in the top menu.

Result: the command will cause the two points to become coincident and be replaced by a single point.

Note: In order to make two points coincident, FreeCAD must out of necessity move one (or both) of the original points.


General scripting

The constraint can be created from macros and from the python console by using the following command:


where :

  • Sketch is a sketch object
  • LineFixed is the number of the line, that will not move by applying the constraint
  • PointOfLineFixed is the number of the vertex of the line LineFixed that has to fulfilled the constraint
  • LineMoving is the number of the line, that will move by applying the constraint
  • PointOfLineMoving is the number of the line LineMoving, that has to fulfilled the constraint

The main issue by using this function is to identify correctly the line number and the vertex number of the lines you want to process.

The next paragraph will explain you how to identify the numbering of a line and of a vertex of a line.

Identifying the numbering of a line

I have drawn three lines as shown in the following figure.


By moving the cursor of the mouse above the line you can see the line number at the bottom left of the FreeCAD windows, see next figure.


Unfortunately the numbering displayed on the FreeCAD windows start from 1 whereas the numbering of the line used to script start from 0: this means that you have to retrieve one each time you want to refer to a line.

Identifying the numbering of the vertices of a line

The vertices of one line can only have the value 1 or 2. (Note that the vertices numbering does not start from 0, this is because with regards to Constraints 0= Edge hence not a vertex, 1 = starting point vertex, 2 = end point vertex, 3 = midpoint which is not a vertex) The vertices are numbered according to their order of creation. To find out the order of their creation (If you have a lot of lines, you cannot remember which vertex you have created first), you just have to move the cursor of your mouse above the two vertices of one line, see following figure.


If you read e.g. 4 and 5, it means that the vertex 4 will be referenced by using the number 1 in the script command and the vertex 5 will be referenced by using the number 2 in the script command. Etc.


Let us take the previous example of the three lines. The subsequent figure indicates the numbering of each line and their vertices according to the convention for scripting.


blue text: numbering of line, black text: numbering of vertices

The command Sketch.addConstraint(Sketcher.Constraint('Coincident',1,2,2,1)) yields following result:


The command Sketch.addConstraint(Sketcher.Constraint('Coincident',0,2,2,2)) yields following result: