# Sketcher scripting

## Creating a SketchObject using Python

We create a SketchObject like this:

```
import FreeCAD as App
import Part
import Sketcher
doc = App.newDocument()
sketch = doc.addObject("Sketcher::SketchObject", "Sketch")
sketch.addGeometry(Part.LineSegment(App.Vector(1.2, 1.8, 0),
App.Vector(5.2, 5.3, 0)), False)
sketch.addGeometry(Part.LineSegment(App.Vector(6.5, 1.5, 0),
App.Vector(10.2, 5.0, 0)), False)
sketch.addGeometry(Part.LineSegment(App.Vector(12.2, 1.0, 0),
App.Vector(15.4, 5.0, 0)), False)
doc.recompute()
```

It also adds three lines in the newly created Sketch.

## Creating a constraint using Python

A geometric constraint and the special InternalAlignment constraints can be created from macros and from the Python console by using the following command:

```
sketch.addConstraint(Sketcher.Constraint(ConstraintType, EdgeOrPartOfEdge…))
```

A dimensional constraint and the special constraint Snell's law can be created from macros and from the Python console by using the following command:

```
sketch.addConstraint(Sketcher.Constraint(DimensionalConstraintType, EdgeOrPartOfEdge…, App.Units.Quantity("float_value unit")))
```

e.g.

```
sketch.addConstraint(Sketcher.Constraint(DimensionalConstraintType, EdgeOrPartOfEdge…, App.Units.Quantity("123.0 mm")))
```

The first argument `ConstraintType`

is described below in Constraint types.

A constraint can take up to six arguments which are edges or indicate which sub-part of an edge is used by the constraint. See the documentation of individual constraints for details on what combinations of edges and sub-parts of edges can be passed as arguments. The main issue with this function is to identify correctly the line number and the vertex number of the lines you want to process. The sections below describe how to identify the numbering of a line, and how to Identify the numbering of the sub-parts of a line.

## Constraint types

For geometric constraints, the first argument is one of the following. See the corresponding feature page for the possible combinations of arguments allowed for each constraint.

Code | Icon | Feature |
---|---|---|

`"Coincident"` |
Coincident | |

`"PointOnObject"` |
Point On Object | |

`"Vertical"` |
Vertical | |

`"Horizontal"` |
Horizontal | |

`"Parallel"` |
Parallel | |

`"Perpendicular"` |
Perpendicular | |

`"Tangent"` |
Tangent | |

`"Equal"` |
Equal | |

`"Symmetric"` |
Symmetric | |

`"Block"` |
Block |

The InternalAlignment constraints behave like geometric constraints for the purposes of scripting. Again, see the corresponding feature page for the possible combinations of arguments allowed for each constraint.

Code | Icon | Feature |
---|---|---|

`"InternalAlignment:EllipseMajorDiameter"` |
InternalAlignment | |

`"InternalAlignment:EllipseMinorDiameter"` |
InternalAlignment | |

`"InternalAlignment:EllipseFocus1"` |
InternalAlignment | |

`"InternalAlignment:EllipseFocus2"` |
InternalAlignment |

For dimensional constraints, the first argument is one of the following. See the corresponding feature page for the possible combinations of arguments allowed for each constraint.

Code | Icon | Feature |
---|---|---|

`"DistanceX"` |
Horizontal distance | |

`"DistanceY"` |
Vertical distance | |

`"Distance"` |
Distance | |

`"Radius"` |
Radius | |

`"Diameter"` |
Diameter | |

`"Angle"` |
Angle | |

`"AngleViaPoint"` |
Angle |

The Snell's law constraints behave like dimensional contraints for the purposes of scripting. Again, see the corresponding feature page for the possible combinations of arguments allowed for each constraint.

Code | Icon | Feature |
---|---|---|

`"SnellsLaw"` |
Snell's law |

The Lock constraint is a GUI command which creates a Horizontal distance and a Vertical distance constraint, it is not a constraint of its own.

## 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 subtract one each time you want to refer to a line.

Positive numbers indicate sketch edges (straight lines, circles, conics, B-splines, and so on). The following values can be used to denote elements that are not sketch edges:

`-1`

denotes the horizontal x axis`-2`

denotes the vertical y axis`-n`

denotes the external geometry element number`n-3`

(e.g. the external geometry element with index 0 in the flattened list`sketch.ExternalGeometry`

would be denoted by -3, the following element in the flattened list would be -4 and so on).

## Identifying the numbering of the sub-parts of a line

When qualifying which part of a line is affected by a constraint, the following values can be used:

`0`

to indicate that the constraint affects the entire edge.`1`

to indicate that the constraint affects the starting point of the edge (a full circle has no starting point).`2`

to indicate that the constraint affects the end point of the edge.`3`

to indicate that the constraint affects the center point of the edge. For Circles and Conics (ellipses), this is the center of the circle or center (intersection of major and minor axes) of the ellipse. For straight Lines,`3`

cannot be used to indicate the center point.`n`

to indicate that the constraint affects the n-th pole of a B-Spline.

The vertices indicated by 1 and 2 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 with the lower number (4 in this example) will be referenced by using the number 1 (first in the script command and the vertex with the higher number (5 in this example) will be referenced by using the number 2 in the script command.

## Example

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 full code to draw the three lines and add a Coincident constraint on two points from two lines is like this:

```
import FreeCAD as App
import Part
import Sketcher
doc = App.newDocument()
sketch = doc.addObject("Sketcher::SketchObject", "Sketch")
sketch.addGeometry(Part.LineSegment(App.Vector(1.2, 1.8, 0),
App.Vector(5.2, 5.3, 0)), False)
sketch.addGeometry(Part.LineSegment(App.Vector(6.5, 1.5, 0),
App.Vector(10.2, 5.0, 0)), False)
sketch.addGeometry(Part.LineSegment(App.Vector(12.2, 1.0, 0),
App.Vector(15.4, 5.0, 0)), False)
sketch.addConstraint(Sketcher.Constraint("Coincident", 1, 2, 2, 1))
doc.recompute()
```

**General:**Create sketch, Edit sketch, Leave sketch, View sketch, View section, Map sketch to face, Reorient sketch, Validate sketch, Merge sketches, Mirror sketch, Stop operation

**Sketcher geometries:**Point, Line, Arc, Arc by 3 points, Circle, Circle by 3 points, Ellipse, Ellipse by 3 points, Arc of ellipse, Arc of hyperbola, Arc of parabola, B-spline, Periodic B-pline, Polyline, Rectangle, Centered rectangle, Rounded rectangle, Triangle, Square, Pentagon, Hexagon, Heptagon, Octagon, Regular polygon, Slot, Fillet, Trim, Extend, Split, External geometry, Carbon copy, Toggle construction geometry

**Sketcher constraints:****Geometric constraints:**Coincident, Point on object, Vertical, Horizontal, Parallel, Perpendicular, Tangent, Equal, Symmetric, Block**Dimensional constraints:**Lock, Horizontal distance, Vertical distance, Distance, Radius, Diameter, Radiam, Angle, Snell's law, Internal alignment**Constraint tools:**Toggle driving/reference constraint, Activate/deactivate constraint

**Sketcher tools:**Select unconstrained DoF, Close shape, Connect edges, Select associated constraints, Select associated geometry, Select redundant constraints, Select conflicting constraints, Show/hide internal geometry, Select origin, Select vertical axis, Select horizontal axis, Symmetry, Clone, Copy, Move, Rectangular array, Remove axes alignment, Delete all geometry, Delete all constraints

**Sketcher B-spline tools:**Show/hide B-spline degree, Show/hide B-spline control polygon, Show/hide B-spline curvature comb, Show/hide B-spline knot multiplicity, Show/hide B-spline control point weight, Convert geometry to B-spline, Increase B-spline degree, Decrease B-spline degree, Increase knot multiplicity, Decrease knot multiplicity, Insert knot

**Sketcher virtual space:**Switch virtual space

**Additional:**Sketcher Dialog, Preferences, Sketcher scripting

**Getting started****Installation:**Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap**Basics:**About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

**Help:**Tutorials, Video tutorials**Workbenches:**Std Base, Arch, Draft, FEM, Image, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Points, Raytracing, Reverse Engineering, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web**Deprecated or unmaintained workbenches:**Complete, Drawing, Robot

**Hubs:**User hub, Power users hub, Developer hub