Sketcher ConstrainDistanceX: Difference between revisions

From FreeCAD Documentation
(<translate>)
(Scripting_Sketcher_constraints_in_Python -> Sketcher_scripting)
(38 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
<!--T:9-->
{{GuiCommand|Name=Constraint HorizontalDistance|Workbenches=[[Sketcher Workbench|Sketcher]], [[PartDesign Workbench|PartDesign]]|MenuLocation=Sketch → Sketcher constraints → Constrain horizontal distance|SeeAlso=[[Constraint Length]], [[Constraint VerticalDistance]]}}
{{Docnav
|[[Sketcher_ConstrainLock|Lock]]
|[[Sketcher_ConstrainDistanceY|Vertical Distance]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainLock.svg‎
|IconR=Sketcher_ConstrainDistanceY.svg
|IconC=Workbench_Sketcher.svg
}}


<!--T:1-->
====Description====
{{GuiCommand
Fixes the horizontal distance between 2 points or line ends. If only one item is selected, the distance is set to the origin.
|Name=Sketcher ConstrainDistanceX
|MenuLocation=Sketch → Sketcher constraints → Constrain horizontal distance
|Workbenches=[[Sketcher_Workbench|Sketcher]]
|Shortcut={{KEY|Shift}} + {{KEY|H}}
|SeeAlso=[[Sketcher_ConstrainDistance|Sketcher Constrain Length]], [[Sketcher_ConstrainDistanceY|Sketcher Constrain Vertical Distance]]
}}


==Description== <!--T:2-->
====Usage====

# Pick one or two points
<!--T:6-->
# Activate the constraint
Fixes the horizontal distance between 2 points or line ends. If only one point is selected, the distance is set to the sketch origin.
{{clear}}


</translate>
</translate>
[[File:Constraint_H_Distance.png]]
<languages/>
<translate>

==Usage== <!--T:3-->

<!--T:7-->
# 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|Shift}} + {{KEY|H}} keyboard shortcut. ('''H''' is for '''H'''orizontal)
#* 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.

<!--T:4-->
'''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.

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

<!--T:14-->
Distance from origin:

</translate>
{{Code|code=Sketch.addConstraint(Sketcher.Constraint('DistanceX', Edge, PointOfEdge, App.Units.Quantity('123.0 mm')))}}
<translate>

<!--T:15-->
Distance between two vertices:

</translate>
{{Code|code=Sketch.addConstraint(Sketcher.Constraint('DistanceX', Edge1, PointOfEdge1, Edge2, PointOfEdge2, App.Units.Quantity('123.0 mm')))}}
<translate>

<!--T:16-->
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:

</translate>
{{Code|code=Sketch.addConstraint(Sketcher.Constraint('DistanceX', Line, 1, Line, 2, App.Units.Quantity('123.0 mm')))}}
<translate>

<!--T:17-->
The [[Sketcher_scripting|Sketcher scripting]] page explains the values which can be used for {{incode|Edge1}}, {{incode|Edge2}}, {{incode|Edge}}, {{incode| PointOfEdge1}}, {{incode| PointOfEdge2}}, {{incode|PointOfEdge}} and {{incode|Line}}, and contains further examples on how to create constraints from Python scripts.


<!--T:10-->
{{Docnav
|[[Sketcher_ConstrainLock|Lock]]
|[[Sketcher_ConstrainDistanceY|Vertical Distance]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainLock.svg‎
|IconR=Sketcher_ConstrainDistanceY.svg
|IconC=Workbench_Sketcher.svg
}}

</translate>
{{Sketcher Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 23:26, 23 January 2021

Sketcher ConstrainDistanceX

Menu location
Sketch → Sketcher constraints → Constrain horizontal distance
Workbenches
Sketcher
Default shortcut
Shift + H
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.

Usage

  1. Pick one or two points or one line.
  2. Invoke the tool several ways:
    • Press the Constrain horizontal distance button in the toolbar.
    • Use the Shift + H keyboard shortcut. (H is for Horizontal)
    • Use the Sketch → Sketcher constraints → 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, 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 Edge1, Edge2, Edge, PointOfEdge1, PointOfEdge2, PointOfEdge and Line, and contains further examples on how to create constraints from Python scripts.