Sketcher ConstrainDistanceX

    From FreeCAD Documentation

    Sketcher ConstrainDistanceX.svg Sketcher ConstrainDistanceX

    Menu location
    Sketch → Sketcher constraints → Constrain horizontal distance
    Workbenches
    Sketcher
    Default shortcut
    L
    Introduced in version
    -
    See also
    Sketcher Constrain Length, Sketcher Constrain Vertical Distance

    Description

    Fixes the horizontal distance between 2 points or line ends. If only one point is selected, the distance is set to the sketch origin.

    Constraint H Distance.png

    Usage

    1. Pick one or two points or one line.
    2. Invoke the tool several ways:
      • Press the Sketcher ConstrainDistanceX.svg Constrain horizontal distance button in the toolbar.
      • Use the L keyboard shortcut.
      • Use the Sketch → Sketcher constraints → Sketcher ConstrainDistanceX.svg Constrain horizontal distance from the top menu.
    3. A pop up dialog opens to edit or confirm the value. Press OK to validate.

    Note: the constraint tool can also be started with no prior selection, but will require selection of two points or one line. To set the distance to the origin, the sketch origin point needs to be selected as well. By default the command will be in continue mode to create new constraints; press the right mouse button or Esc once to quit the command.

    Scripting

    Distance from origin:

    Sketch.addConstraint(Sketcher.Constraint('DistanceX', Edge, PointOfEdge, -1, 1, App.Units.Quantity('123.0 mm')))
    

    Distance between two vertices:

    Sketch.addConstraint(Sketcher.Constraint('DistanceX', Edge1, PointOfEdge1, Edge2, PointOfEdge2, App.Units.Quantity('123.0 mm')))
    

    Horizontal span of line (the GUI allows selecting the edge itself, but it is just a shorthand for using the two extremities of the same line):

    Sketch.addConstraint(Sketcher.Constraint('DistanceX', Line, 1, Line, 2, App.Units.Quantity('123.0 mm')))
    

    The Sketcher scripting page explains the values which can be used for Edge, Edge1, Edge2, PointOfEdge, PointOfEdge1, PointOfEdge2 and Line, and contains further examples on how to create constraints from Python scripts.