Sketcher ConstrainDistance: Difference between revisions

From FreeCAD Documentation
m (Changed section to 'Usage')
 
(56 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{Page_in_progress}}
<translate>
<translate>

<!--T:12-->
<!--T:12-->
{{Docnav
{{Docnav|[[Sketcher_ConstrainDistanceY|Vertical Distance]]|[[Sketcher_ConstrainRadius|Radius]]|[[Sketcher_Workbench|Sketcher]]|IconL=Constraint_VerticalDistance.png|IconC=Workbench_Sketcher.svg|IconR=Constraint_Radius.png}}
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_ConstrainRadiam|Auto radius/diameter]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainRadiam.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|K}} {{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-->

'''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.
<!--T:2-->
The [[Image:Sketcher_ConstrainDistance.svg|24px]] [[Sketcher_ConstrainDistance|Sketcher ConstrainDistance]] tool
fixes the length of a line, the distance between two points, the perpendicular distance between a point and a line, or, {{Version|0.21}}, the distance between the edges of two circles or arcs, or between the edge of a circle or arc and a line.


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


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

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

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


<!--T:10-->
<!--T:10-->
# Make sure there is no selection.
# Pick two points or one line or one point and one line.
# There are several ways to invoke the tool:
# Press the {{KEY|[[File:Sketcher ConstrainDistance.png|24px]] '''Constrain distance'''}} button.
#* {{Version|0.22}}: 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_ConstrainDistance.svg|16px]] Constrain distance}} option from the dropdown.
# A pop up dialog opens to edit or confirm the value. Press {{KEY|OK}} to validate.
#* If this preference has a different value (and in {{VersionMinus|0.21}}): press the {{Button|[[Image:Sketcher_ConstrainDistance.svg|16px]] [[Sketcher_ConstrainDistance|Constrain distance]]}} button.
#* Select the {{MenuCommand|Sketch → Sketcher constraints → [[File:Sketcher_ConstrainDistance.svg|16px]] Constrain distance}} option from the menu.
#* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|Dimension → [[Image:Sketcher_ConstrainDistance.svg|16px]] Constrain distance}} option from the context menu.
#* Use the keyboard shortcut {{KEY|K}} then {{KEY|D}}.
# The cursor changes to a white cross with the tool icon.
# Do one of the following:
#* Select a single line.
#* Select two points.
#* Select a point and a line (in that order).
# 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===
<!--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.


# Do one of the following:
===Hint=== <!--T:3-->
#* Select a single line.
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.
#* Select two points.
#* Select a point and a line (in any order).
#* Select the edges of two circles or arcs.
#* Select the edge of a circle or arc and a line (idem).
# Invoke the tool as explained above.
# Optionally [[Sketcher_Workbench#Edit_constraints|edit the constraint value]].
# A constraint is added.


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


<!--T:14-->
<!--T:3-->
* If applicable please consider using the [[Image:Sketcher_ConstrainDistanceX.svg|16px]] [[Sketcher_ConstrainDistanceX|Horizontal distance]] or [[Image:Sketcher_ConstrainDistanceY.svg|16px]] [[Sketcher_ConstrainDistanceY|Vertical distance]] constraints instead. They are more efficient.
{{Sketcher Tools navi}}


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

{{Userdocnavi}}
<!--T:18-->
Distance from origin:

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

<!--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 perpendicular point on line ({{incode|Line}}):

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

<!--T:24-->
Distance between the edges of two circles:

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

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


<!--T:13-->
{{Docnav
|[[Sketcher_ConstrainDistanceY|Vertical distance]]
|[[Sketcher_ConstrainRadiam|Auto radius/diameter]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_ConstrainDistanceY.svg
|IconR=Sketcher_ConstrainRadiam.svg
|IconC=Workbench_Sketcher.svg
}}


</translate>
</translate>
{{Sketcher_Tools_navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 18:59, 11 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 ConstrainDistance

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

Description

The Sketcher ConstrainDistance tool fixes the length of a line, the distance between two points, the perpendicular distance between a point and a line, or, introduced in version 0.21, the distance between the edges of two circles or arcs, or between the edge of a circle or arc and a line.

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 0.22: 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 distance option from the dropdown.
    • If this preference has a different value (and in version 0.21 and below): press the Constrain distance button.
    • Select the Sketch → Sketcher constraints → Constrain distance option from the menu.
    • introduced in version 0.22: Right-click in the 3D view and select the Dimension → Constrain distance option from the context menu.
    • Use the keyboard shortcut K then D.
  3. The cursor changes to a white cross with the tool icon.
  4. Do one of the following:
    • Select a single line.
    • Select two points.
    • Select a point and a line (in that order).
  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 a single line.
    • Select two points.
    • Select a point and a line (in any order).
    • Select the edges of two circles or arcs.
    • Select the edge of a circle or arc and a line (idem).
  2. Invoke the tool as explained above.
  3. Optionally edit the constraint value.
  4. A constraint is added.

Notes

Scripting

Distance from origin:

Sketch.addConstraint(Sketcher.Constraint('Distance', Edge, PointOfEdge, -1, 1, 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 perpendicular point on line (Line):

Sketch.addConstraint(Sketcher.Constraint('Distance', Edge, PointOfEdge, Line, 0, App.Units.Quantity('123.0 mm')))

Distance between the edges of two circles:

Sketch.addConstraint(Sketcher.Constraint('Distance', Circle1, 0, Circle2, 0, App.Units.Quantity('123.0 mm')))

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