Sketcher ConstrainDistanceX/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:


{{Docnav
{{Docnav
|[[Sketcher_Dimension|Dimension]]
|[[Sketcher_ConstrainLock|Lock]]
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_Workbench|Sketcher]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainLock.svg‎
|IconL=Sketcher_Dimension.svg‎
|IconR=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainDistanceY.svg
|IconC=Workbench_Sketcher.svg
|IconC=Workbench_Sketcher.svg
Line 15: Line 15:
|Workbenches=[[Sketcher_Workbench|Sketcher]]
|Workbenches=[[Sketcher_Workbench|Sketcher]]
|Shortcut={{KEY|L}}
|Shortcut={{KEY|L}}
|SeeAlso=[[Sketcher_ConstrainDistance|Sketcher Constrain Length]], [[Sketcher_ConstrainDistanceY|Sketcher Constrain Vertical Distance]]
|SeeAlso=[[Sketcher_ConstrainDistanceY|Sketcher ConstrainDistanceY]], [[Sketcher_ConstrainDistance|Sketcher ConstrainDistance]]
}}
}}


==Description==
==Description==


The [[Image:Sketcher_ConstrainDistanceX.svg|24px]] [[Sketcher_ConstrainDistanceX|Sketcher ConstrainDistanceX]] tool
Fixes the horizontal distance between 2 points or line ends. If only one point is selected, the distance is set to the sketch origin.
fixes the horizontal distance between two points or the endpoints of a line. If a single point is pre-selected, the distance is relative to the origin of the sketch.


[[File:Constraint_H_Distance.png]]
[[File:Constraint_H_Distance.png]]
Line 26: Line 27:
==Usage==
==Usage==


See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]].
# Pick one or two points or one line.
# Invoke the tool several ways:
#* Press the {{Button|[[File:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Constrain horizontal distance]]}} button in the toolbar.
#* Use the {{KEY|L}} keyboard shortcut.
#* Use the {{MenuCommand|Sketch → Sketcher constraints → [[File:Sketcher_ConstrainDistanceX.svg|16px]] Constrain horizontal distance}} from the top menu.
# A pop up dialog opens to edit or confirm the value. Press {{Button|OK}} to validate.


===[[Sketcher_Workbench#Continue_modes|Continue mode]]===
'''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 {{KEY|Esc}} once to quit the command.

# Make sure there is no selection.
# There are several ways to invoke the tool:
#* {{Version|1.0}}: If the {{MenuCommand|Dimensioning constraints}} [[Sketcher_Preferences#General|preference]] is set to {{Value|Single tool}} (default): press the down arrow to the right of the {{Button|[[Image:Sketcher_Dimension.svg||x16px]][[Image:Toolbar_flyout_arrow.svg|x16px]]}} button and select the {{MenuCommand|[[Image:Sketcher_ConstrainDistanceX.svg|16px]] Constrain horizontal distance}} option from the dropdown.
#* If this preference has a different value (and in {{VersionMinus|0.21}}): press the {{Button|[[Image:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Constrain horizontal distance]]}} button.
#* Select the {{MenuCommand|Sketch → Sketcher constraints → [[Image:Sketcher_ConstrainDistanceX.svg|16px]] Constrain horizontal distance}} option from the menu.
#* {{Version|1.0}}: 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}}.
# The cursor changes to a cross with the tool icon.
# Do one of the following:
#* Select two points (one of which can be the origin).
#* Select a single line.
# If a [[Sketcher_ToggleDrivingConstraint|driving dimensional constraint]] is created, depending on the [[Sketcher_Preferences#Display|preferences]], a dialog opens to [[Sketcher_Workbench#Edit_constraints|edit its value]].
# A constraint is added.
# Optionally keep creating constraints.
# To finish, right-click or press {{KEY|Esc}}, or start another geometry or constraint creation tool.

===Run-once mode===

# Do one of the following:
#* Select one or two points.
#* Select a single line.
# Invoke the tool as explained above.
# Optionally [[Sketcher_Workbench#Edit_constraints|edit the constraint value]].
# A constraint is added.


== Scripting ==
== Scripting ==
Line 53: Line 74:


{{Docnav
{{Docnav
|[[Sketcher_Dimension|Dimension]]
|[[Sketcher_ConstrainLock|Lock]]
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_Workbench|Sketcher]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainLock.svg‎
|IconL=Sketcher_Dimension.svg‎
|IconR=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainDistanceY.svg
|IconC=Workbench_Sketcher.svg
|IconC=Workbench_Sketcher.svg

Latest revision as of 13:31, 24 April 2024

Sketcher ConstrainDistanceX

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

Description

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

Usage

See also: Drawing aids.

Continue mode

  1. Make sure there is no selection.
  2. There are several ways to invoke the tool:
    • introduced in version 1.0: If the Dimensioning constraints preference is set to Single tool (default): press the down arrow to the right of the button and select the Constrain horizontal distance option from the dropdown.
    • If this preference has a different value (and in version 0.21 and below): press the Constrain horizontal distance button.
    • Select the Sketch → Sketcher constraints → Constrain horizontal distance option from the menu.
    • introduced in version 1.0: 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 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. If a driving dimensional constraint is created, depending on the preferences, a dialog opens to edit its value.
  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.

Run-once mode

  1. Do one of the following:
    • Select one or two points.
    • Select a single line.
  2. Invoke the tool as explained above.
  3. Optionally edit the constraint value.
  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.