Sketcher ConstrainDistanceX: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Line 35: Line 35:


See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]].
See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]].

===[[Sketcher_Workbench#Continue_modes|Continue mode]]===


<!--T:7-->
<!--T:7-->
# Make sure there is no selection.
# Pick one or two points, or a single line (skip this step if the tool should run in [[Sketcher_Workbench#Continue_modes|continue mode]]).
# There are several ways to invoke the tool:
# There are several ways to invoke the tool:
#* Press the {{Button|[[Image:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Constrain horizontal distance]]}} button.
#* Press the {{Button|[[Image:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Constrain horizontal distance]]}} button.
Line 43: Line 45:
#* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|Dimension → [[Image:Sketcher_ConstrainDistanceX.svg|16px]] Constrain horizontal distance}} option from the context menu.
#* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|Dimension → [[Image:Sketcher_ConstrainDistanceX.svg|16px]] Constrain horizontal distance}} option from the context menu.
#* Use the keyboard shortcut: {{KEY|L}}.
#* Use the keyboard shortcut: {{KEY|L}}.
# The cursor changes to a white cross with the tool icon.
# If there is a selection: confirm the constraint value in the pop up dialog.
# Do one of the following:
# If the tool runs in [[Sketcher_Workbench#Continue_modes|continue mode]]:
## The cursor changes to a white cross with the tool icon.
#* Select two points (one of which can be the origin).
#* Select a single line.
## Do one of the following:
# Confirm the constraint value in the pop up dialog.
##* Select two points (one of which can be the origin).
# A constraint is added.
##* Select a single line.
# Optionally keep creating constraints.
## Confirm the constraint value in the pop up dialog.
# To finish, right-click or press {{KEY|Esc}}, or start another geometry or constraint creation tool.
## Optionally keep creating constraints.

## To finish, right-click or press {{KEY|Esc}}, or start another geometry or constraint creation tool.
===Once-only mode===

# Pick one or two points, or a single line.
# Invoke the tool as explained above.
# Confirm the constraint value in the pop up dialog.
# A constraint is added.


== Scripting == <!--T:13-->
== Scripting == <!--T:13-->

Revision as of 10:29, 7 March 2024

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

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

The Sketcher ConstrainDistanceX tool fixes the horizontal distance between two points or the endpoints of a line. If only one point is pre-selected, the distance is set to the sketch origin.

Usage

See also: Drawing aids.

Continue mode

  1. Make sure there is no selection.
  2. There are several ways to invoke the tool:
    • Press the Constrain horizontal distance button.
    • Select the Sketch → Sketcher constraints → Constrain horizontal distance option from the menu.
    • introduced in version 0.22: Right-click in the 3D view and select the Dimension → Constrain horizontal distance option from the context menu.
    • Use the keyboard shortcut: L.
  3. The cursor changes to a white cross with the tool icon.
  4. Do one of the following:
    • Select two points (one of which can be the origin).
    • Select a single line.
  5. Confirm the constraint value in the pop up dialog.
  6. A constraint is added.
  7. Optionally keep creating constraints.
  8. To finish, right-click or press Esc, or start another geometry or constraint creation tool.

Once-only mode

  1. Pick one or two points, or a single line.
  2. Invoke the tool as explained above.
  3. Confirm the constraint value in the pop up dialog.
  4. A constraint is added.

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.