Sketcher ConstrainDistance: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
(26 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:12-->
{{Docnav
|[[Sketcher_ConstrainDistanceY|Vertical Distance]]
|[[Sketcher_ConstrainRadius|Radius]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainRadius.svg
|IconC=Workbench_Sketcher.svg
}}

<!--T:1-->
<!--T:1-->
{{GuiCommand
{{GuiCommand
|Name=Sketcher ConstrainDistance
|Name=Sketcher ConstrainDistance
|Workbenches=[[Sketcher Workbench|Sketcher]]
|MenuLocation=Sketch → Sketcher constraints → Constrain distance
|MenuLocation=Sketch → Sketcher constraints → Constrain distance
|Workbenches=[[Sketcher_Workbench|Sketcher]]
|Shortcut=Shift + D
|Shortcut={{KEY|Shift}} + {{KEY|D}}
|SeeAlso=[[Sketcher ConstrainDistanceX|Constrain horizontal distance]], [[Sketcher ConstrainDistanceY|Constrain vertical distance]]
|SeeAlso=[[Sketcher_ConstrainDistanceX|Sketcher Constrain horizontal distance]], [[Sketcher_ConstrainDistanceY|Sketcher Constrain vertical distance]]
}}
}}


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

<!--T:2-->
'''Constrain distance''' constrains the length of a line, the perpendicular distance between a point and a line or the distance between two points to have a specified value.
'''Constrain distance''' constrains the length of a line, the perpendicular distance between a point and a line or the distance between two points to have a specified value.


</translate>
</translate>
[[Image:Sketcher_ConstrainDistance_example.png]]
[[File:Sketcher ConstrainDistance example.png|none]]
<translate>
<translate>


==How to use== <!--T:9-->
==Usage== <!--T:9-->


<!--T:10-->
<!--T:10-->
# Pick two points or one line or one point and one line.
# Pick two points or one line or one point and one line.
# Invoke the command several ways:
# Press the {{KEY|[[File:Sketcher ConstrainDistance.png|24px]] '''Constrain distance'''}} button.
#* Press the {{Button|[[File:Sketcher_ConstrainDistance.svg|16px]] [[Sketcher_ConstrainDistance|Constrain distance]]}} button in the Sketcher toolbar.
# A pop up dialog opens to edit or confirm the value. Press {{KEY|OK}} to validate.
#* Use the {{KEY|Shift}} + {{KEY|D}} keyboard shortcut. ('''D''' is for '''D'''istance)
#* Use the {{MenuCommand|Sketch → Sketcher constraints → [[File:Sketcher_ConstrainDistance.svg|16px]] Constrain distance}} entry from the top menu.
# A pop up dialog opens to edit or confirm the value. Press {{Button|OK}} to validate.


<!--T:8-->
<!--T:8-->
'''Note:''' the constraint tool can also be started with no prior selection. To set the perpendicular distance between a point and a line, the point needs to be selected first. 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.
'''Note:''' the constraint tool can also be started with no prior selection. To set the perpendicular distance between a point and a line, the point needs to be selected first. 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.


===Hint=== <!--T:3-->
===Hint=== <!--T:16-->

If applicable please consider using the [[Sketcher ConstrainDistanceX|Horizontal distance]] or [[Sketcher ConstrainDistanceY|Vertical distance]] constraints instead. These constraints are more robust and faster to calculate than the here documented length constraint.
<!--T:3-->
If applicable please consider using the {{Button|[[File:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Horizontal distance]]}} or {{Button|[[File:Sketcher_ConstrainDistanceY.svg|16px]] [[Sketcher_ConstrainDistanceY|Vertical distance]]}} constraints instead. These constraints are more robust and faster to calculate than the '''ConstrainDistance''' tool.

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

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


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

[[Category:Sketcher]]
<!--T:19-->
Distance between two vertices:

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

<!--T:20-->
Length 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('Distance', Line, 1, Line, 2, App.Units.Quantity('123.0 mm')))}}
<translate>

<!--T:21-->
Distance from point ({{incode|Edge, PointOfEdge}}) to nearest point on line ({{incode|Line}}):

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

<!--T:22-->
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:13-->
{{Docnav
|[[Sketcher_ConstrainDistanceY|Vertical Distance]]
|[[Sketcher_ConstrainRadius|Radius]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainRadius.svg
|IconC=Workbench_Sketcher.svg
}}

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

Revision as of 09:15, 12 September 2021

Sketcher ConstrainDistance

Menu location
Sketch → Sketcher constraints → Constrain distance
Workbenches
Sketcher
Default shortcut
Shift + D
Introduced in version
-
See also
Sketcher Constrain horizontal distance, Sketcher Constrain vertical distance

Description

Constrain distance constrains the length of a line, the perpendicular distance between a point and a line or the distance between two points to have a specified value.

Usage

  1. Pick two points or one line or one point and one line.
  2. Invoke the command several ways:
    • Press the Constrain distance button in the Sketcher toolbar.
    • Use the Shift + D keyboard shortcut. (D is for Distance)
    • Use the Sketch → Sketcher constraints → Constrain distance entry 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. To set the perpendicular distance between a point and a line, the point needs to be selected first. 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.

Hint

If applicable please consider using the Horizontal distance or Vertical distance constraints instead. These constraints are more robust and faster to calculate than the ConstrainDistance tool.

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('Distance', Edge1, PointOfEdge1, Edge2, PointOfEdge2, App.Units.Quantity('123.0 mm')))

Length 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('Distance', Line, 1, Line, 2, App.Units.Quantity('123.0 mm')))

Distance from point (Edge, PointOfEdge) to nearest point on line (Line):

Sketch.addConstraint(Sketcher.Constraint('Distance', Edge, PointOfEdge, Line, 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.