Sketcher ConstrainDistance: Difference between revisions

From FreeCAD Documentation
(launch option added)
(WIP)
Line 1: Line 1:
<languages/>
<languages/>
{{Page_in_progress}}
<translate>
<translate>


Line 32: Line 33:


==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 one line, or one point and one line, or two points, or the edges of two circles, or the edge of one circle and one line.
# There are several ways to invoke the command:
# There are several ways to invoke the tool:
#* Press the {{Button|[[File:Sketcher_ConstrainDistance.svg|16px]] [[Sketcher_ConstrainDistance|Constrain distance]]}} button.
#* Press the {{Button|[[File: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.
#* 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.
#* {{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}}.
#* Use the keyboard shortcut {{KEY|K}} then {{KEY|D}}.
# The cursor changes to a white cross with the tool icon.
# A pop up dialog opens to edit or confirm the value. Press {{Button|OK}} to validate.
# Do one of the following:
#* Select a single line.
#* Select two points.
#* Select a point and a line (in that order).
# If the {{MenuCommand|Ask for value after creating a dimensional constraint}} option is selected (default) in the [[Sketcher_Preferences#Display|Sketcher Preferences]]:
## A pop up dialog opens to edit the constraint value.
## Press the {{Button|OK}} button to confirm.
# A constraint is added.
# Optionally keep creating constraints.
# To finish, right-click or press {{KEY|Esc}}, or start another geometry or constraint creation tool

===Once-only mode===


# Do one of the following:
<!--T:8-->
#* Select a single line.
'''Note:''' the constraint tool can also be started with no prior selection (apart from circle to circle and circle to line cases). 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.
#* Select two points.
#* Select a point and a line (in any order).
#* Select two circles.
#* Select a circle and a line (idem).
# Invoke the tool as explained above.
# Edit and/or confirm the constraint value as explained above.
# A constraint is added.


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


<!--T:3-->
<!--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.
* 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. These constraints are faster to calculate.


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

Revision as of 18:14, 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 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 perpendicular distance between a point and a line, the distance between two points, or, introduced in version 0.21, the distance between the edges of two circles or between the edge of a circle 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:
    • 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 the Ask for value after creating a dimensional constraint option is selected (default) in the Sketcher Preferences:
    1. A pop up dialog opens to edit the constraint value.
    2. Press the OK button to confirm.
  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. Do one of the following:
    • Select a single line.
    • Select two points.
    • Select a point and a line (in any order).
    • Select two circles.
    • Select a circle and a line (idem).
  2. Invoke the tool as explained above.
  3. Edit and/or confirm the constraint value as explained above.
  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.