Sketcher ConstrainDistanceY: Difference between revisions

Latest revision as of 18:51, 11 March 2024

Other languages:

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Horizontal distance

Distance

Sketcher

Menu location
Sketcher ConstrainDistanceY
Sketch → Sketcher constraints → Constrain vertical distance
Workbenches
Sketcher
Default shortcut
I
Introduced in version
-
See also
Sketcher Constrain Horizontal Distance, Sketcher Constrain Length

Description

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

Usage

Continue mode

Make sure there is no selection.
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 vertical distance option from the dropdown.
- If this preference has a different value (and in version 0.21 and below): press the Constrain vertical distance button.
- Select the Sketch → Sketcher constraints → Constrain vertical distance option from the menu.
- introduced in version 0.22: Right-click in the 3D view and select the Dimension → Constrain vertical distance option from the context menu.
- Use the keyboard shortcut: I.
For further steps see Sketcher ConstrainDistanceX

Run-once mode

See Sketcher ConstrainDistanceX.

Scripting

Distance from origin:

Sketch.addConstraint(Sketcher.Constraint('DistanceY', Edge, PointOfEdge, -1, 1, App.Units.Quantity('123.0 mm')))

Distance between two vertices:

Sketch.addConstraint(Sketcher.Constraint('DistanceY', Edge1, PointOfEdge1, Edge2, PointOfEdge2, App.Units.Quantity('123.0 mm')))

Vertical 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('DistanceY', 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.

Horizontal distance

Distance

Sketcher

General: Create sketch, Edit sketch, Map sketch to face, Reorient sketch, Validate sketch, Merge sketches, Mirror sketch, Leave sketch, View sketch, View section, Toggle grid, Toggle snap, Configure rendering order, Stop operation

Sketcher geometries: Point, Line, Arc, Arc by 3 points, Circle, Circle by 3 points, Ellipse, Ellipse by 3 points, Arc of ellipse, Arc of hyperbola, Arc of parabola, B-spline by control points, Periodic B-spline by control points, B-spline by knots, Periodic B-spline by knots, Polyline, Rectangle, Centered rectangle, Rounded rectangle, Triangle, Square, Pentagon, Hexagon, Heptagon, Octagon, Regular polygon, Slot, Fillet, Corner-preserving fillet, Trim, Extend, Split, External geometry, Carbon copy, Toggle construction geometry

Sketcher constraints:
- Geometric constraints: Coincident, Point on object, Vertical, Horizontal, Parallel, Perpendicular, Tangent, Equal, Symmetric, Block
- Dimensional constraints: Lock, Horizontal distance, Vertical distance, Distance, Radius or weight, Diameter, Auto radius/diameter, Angle, Refraction (Snell's law)
- Constraint tools: Toggle driving/reference constraint, Activate/deactivate constraint

Sketcher tools: Select unconstrained DoF, Select associated constraints, Select associated geometry, Select redundant constraints, Select conflicting constraints, Show/hide internal geometry, Select origin, Select horizontal axis, Select vertical axis, Symmetry, Clone, Copy, Move, Rectangular array, Remove axes alignment, Delete all geometry, Delete all constraints

Sketcher B-spline tools: Show/hide B-spline degree, Show/hide B-spline control polygon, Show/hide B-spline curvature comb, Show/hide B-spline knot multiplicity, Show/hide B-spline control point weight, Convert geometry to B-spline, Increase B-spline degree, Decrease B-spline degree, Increase knot multiplicity, Decrease knot multiplicity, Insert knot, Join curves

Sketcher virtual space: Switch virtual space

Additional: Sketcher Dialog, Preferences, Sketcher scripting

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
+{{Page_in_progress}}
 <translate>
 <!--T:9-->
+{{Docnav
-{{Docnav|[[Sketcher ConstrainDistanceX|Horizontal Distance]]|[[Sketcher_ConstrainDistance|Distance]]|[[Sketcher_Workbench|Sketcher]]|IconL=Constraint_HorizontalDistance.png‎|IconC=Workbench_Sketcher.svg|IconR=Constraint_Length.png}}
+|[[Sketcher_ConstrainDistanceX|Horizontal distance]]
+|[[Sketcher_ConstrainDistance|Distance]]
+|[[Sketcher_Workbench|Sketcher]]
+|IconL=Sketcher_ConstrainDistanceX.svg‎
+|IconR=Sketcher_ConstrainDistance.svg
+|IconC=Workbench_Sketcher.svg
+}}
 <!--T:1-->
 {{GuiCommand
 |Name=Sketcher ConstrainDistanceY
-|Workbenches=[[Sketcher Workbench|Sketcher]]
 |MenuLocation=Sketch → Sketcher constraints → Constrain vertical distance
+|Workbenches=[[Sketcher_Workbench|Sketcher]]
-|Shortcut=Shift+V
+|Shortcut={{KEY|I}}
-|SeeAlso=[[Sketcher_ConstrainDistanceX|Constrain Horizontal Distance]], [[Sketcher_ConstrainDistance|Constrain Length]]
+|SeeAlso=[[Sketcher_ConstrainDistanceX|Sketcher Constrain Horizontal Distance]], [[Sketcher_ConstrainDistance|Sketcher Constrain Length]]
 }}
@@ Line 16: / Line 25: @@
 <!--T:6-->
+The [[Image:Sketcher_ConstrainDistanceY.svg|24px]] [[Sketcher_ConstrainDistanceY|Sketcher ConstrainDistanceY]] tool
-Fixes the vertical distance between 2 points or line ends. If only one point is selected, the distance is set to the sketch origin.
+fixes the vertical distance between two points or the endpoints of a line. If a single point is pre-selected, the distance is relative to the sketch origin.
 </translate>
-[[File:Sketcher ConstraintDistanceY example.png|none]]
+[[File:Sketcher ConstraintDistanceY example.png]]
 <translate>
-==How to use== <!--T:3-->
+==Usage== <!--T:3-->
+See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]].
+===[[Sketcher_Workbench#Continue_modes|Continue mode]]===
 <!--T:7-->
+# Make sure there is no selection.
-# Pick one or two points or one line.
+# There are several ways to invoke the tool:
-# Press the {{KEY|[[File:Sketcher ConstrainDistanceY.png|24px]] '''Constrain vertical 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_ConstrainDistanceY.svg|16px]] Constrain vertical 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_ConstrainDistanceY.svg|16px]] [[Sketcher_ConstrainDistanceY|Constrain vertical distance]]}} button.
+#* Select the {{MenuCommand|Sketch → Sketcher constraints → [[Image:Sketcher_ConstrainDistanceY.svg|16px]] Constrain vertical distance}} option from the menu.
+#* {{Version|0.22}}: Right-click in the [[3D_view|3D view]] and select the {{MenuCommand|Dimension → [[Image:Sketcher_ConstrainDistanceY.svg|16px]] Constrain vertical distance}} option from the context menu.
+#* Use the keyboard shortcut: {{KEY|I}}.
+# For further steps see [[Sketcher_ConstrainDistanceX#Continue_mode|Sketcher ConstrainDistanceX]]
+===Run-once mode===
-<!--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.
+See [[Sketcher_ConstrainDistanceX#Once-only_mode|Sketcher ConstrainDistanceX]].
-<!--T:10-->
-{{Docnav|[[Sketcher ConstrainDistanceX|Horizontal Distance]]|[[Sketcher_ConstrainDistance|Distance]]|[[Sketcher_Workbench|Sketcher]]|IconL=Constraint_HorizontalDistance.png‎|IconC=Workbench_Sketcher.svg|IconR=Constraint_Length.png}}
-<!--T:11-->
+== Scripting == <!--T:13-->
-{{Sketcher Tools navi}}
-<!--T:12-->
+<!--T:14-->
+Distance from origin:
-{{Userdocnavi}}
+</translate>
+{{Code|code=Sketch.addConstraint(Sketcher.Constraint('DistanceY', Edge, PointOfEdge, -1, 1, App.Units.Quantity('123.0 mm')))}}
+<translate>
+<!--T:15-->
+Distance between two vertices:
+</translate>
+{{Code|code=Sketch.addConstraint(Sketcher.Constraint('DistanceY', Edge1, PointOfEdge1, Edge2, PointOfEdge2, App.Units.Quantity('123.0 mm')))}}
+<translate>
+<!--T:16-->
+Vertical 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('DistanceY', 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|Edge}}, {{incode|Edge1}}, {{incode|Edge2}}, {{incode|PointOfEdge}}, {{incode| PointOfEdge1}}, {{incode| PointOfEdge2}} and {{incode|Line}}, and contains further examples on how to create constraints from Python scripts.
+<!--T:10-->
+{{Docnav
+|[[Sketcher_ConstrainDistanceX|Horizontal distance]]
+|[[Sketcher_ConstrainDistance|Distance]]
+|[[Sketcher_Workbench|Sketcher]]
+|IconL=Sketcher_ConstrainDistanceX.svg‎
+|IconR=Sketcher_ConstrainDistance.svg
+|IconC=Workbench_Sketcher.svg
+}}
 </translate>
+{{Sketcher_Tools_navi{{#translation:}}}}
-{{clear}}
+{{Userdocnavi{{#translation:}}}}