Sketcher Dialog: Difference between revisions
("Constraints" "Context menu") |
(V0.22 -> V1.0) |
||
(71 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
<translate> |
<translate> |
||
{{Page in progress}} |
|||
{{VeryImportantMessage|This page is currently being updated for the coming v0.21}} |
|||
<!--T:1--> |
<!--T:1--> |
||
{{Docnav |
{{Docnav |
||
|[[Sketcher_EditSketch|Edit sketch]] |
|[[Sketcher_EditSketch|Edit sketch]] |
||
|[[ |
|[[Sketcher_MapSketch|Attach sketch]] |
||
|[[Sketcher_Workbench|Sketcher]] |
|[[Sketcher_Workbench|Sketcher]] |
||
|IconL=Sketcher_EditSketch.svg |
|IconL=Sketcher_EditSketch.svg |
||
|IconR= |
|IconR=Sketcher_MapSketch.svg |
||
|IconC=Workbench_Sketcher.svg |
|IconC=Workbench_Sketcher.svg |
||
}} |
}} |
||
</translate> |
</translate> |
||
{{TOCright}} |
|||
<div style="float:right; clean:both; margin-left:0.5em;">__TOC__</div> |
|||
<translate> |
<translate> |
||
==Introduction== <!--T:2--> |
==Introduction== <!--T:2--> |
||
<!--T:3--> |
<!--T:3--> |
||
While a sketch is being edited, or, in other words, while a sketch is in edit mode, the Sketcher Dialog is displayed on the Task tab of the [[Combo_view|Combo view]]. |
|||
If you are in a sketch, the sketcher dialog is shown in the Combo view panel in the tab Tasks (task bar). To jump into a sketch, select it in the model tree an either double-click on it or right-click on it and then select '''Edit sketch''' in the context menu. Another possibility is to click on the toolbar icon [[Image:Sketcher_EditSketch.svg|20px]] ([[Sketcher_EditSketch|Edit sketch]]). |
|||
⚫ | |||
To put a sketch in edit mode see [[Image:Sketcher_EditSketch.svg|16px]] [[Sketcher_EditSketch|Sketcher EditSketch]]. To finish edit mode see [[Image:Sketcher_LeaveSketch.svg|16px]] [[Sketcher_LeaveSketch|Sketcher LeaveSketch]]. |
|||
<!--T:4--> |
<!--T:4--> |
||
The |
The Sketcher Dialog has the following sections: |
||
==Tool parameters== <!--T:41--> |
|||
<!--T:42--> |
|||
{{Version|1.0}} |
|||
<!--T:43--> |
|||
Some tools add a parameters section at the top of the dialog. Available options and/or modes depend on the tool. |
|||
</translate> |
|||
[[Image:Sketcher_Dialog_Line_parameters.png]] |
|||
<translate> |
|||
<!--T:44--> |
|||
{{Caption|The parameters section of the [[Sketcher_CreateLine|Sketcher CreateLine]] tool}} |
|||
==Solver messages== <!--T:5--> |
==Solver messages== <!--T:5--> |
||
<!--T:6--> |
<!--T:6--> |
||
This section informs about the state of the sketch. |
|||
This section informs you about the state of the sketch, if it is under- or over-constrained and how many degrees of freedom the sketch has. By clicking on the the degrees of freedom the under-constrained sketch elements will be highlighted with green color. |
|||
<!--T: |
<!--T:46--> |
||
The possible messages are: |
|||
* Empty sketch |
|||
{| class="wikitable float-right mw-collapsible mw-collapsed" |
|||
* <span style="color:green;">Fully constrained</span> |
|||
⚫ | |||
* Under constrained: <span style="color:blue;text-decoration:underline;">n DoF(s)</span> |
|||
⚫ | |||
* <span style="color:red;">Redundant constraints: </span><span style="color:blue;text-decoration:underline;">(#, #, #)</span> |
|||
⚫ | |||
* <span style="color:red;">Over-constrained: </span><span style="color:blue;text-decoration:underline;">(#, #, #)</span> |
|||
⚫ | |||
| If checked, new created constraints that would be redundant to the existing constraints will automatically be removed. The removal will be silent for constrains that are not dimensional.<br/>Note: For dimensional redundant constraints you will be informed that the new constraint is invalid, no matter if you use {{MenuCommand|Auto Remove Redundants}} or not. |
|||
<!--T:30--> |
|||
If a sketch is under-constrained the number of degrees of freedom (or DoFs) is indicated. Clicking the underlined text will select the under-constrained sketch elements. See [[Image:Sketcher_SelectElementsWithDoFs.svg|16px]] [[Sketcher_SelectElementsWithDoFs|Sketcher SelectElementsWithDoFs]]. |
|||
<!--T:31--> |
|||
If a sketch has redundant constraints or is over-constrained the indices of the involved constraints are indicated. Clicking the underlined text will select them. See [[Image:Sketcher_SelectRedundantConstraints.svg|16px]] [[Sketcher_SelectRedundantConstraints|Sketcher SelectRedundantConstraints]] and [[Image:Sketcher_SelectConflictingConstraints.svg|16px]] [[Sketcher_SelectConflictingConstraints|Sketcher SelectConflictingConstraints]]. |
|||
<!--T:47--> |
|||
The last two messages are displayed in red for a reason: they are warnings that should not be ignored. They indicate issues that must be addressed as they interfere with the solver. |
|||
<!--T:48--> |
|||
The last three messages are not mutually exclusive. If more than one applies only the most important message, occurring lowest in the list, is displayed. |
|||
<!--T:32--> |
|||
Available options: |
|||
<!--T:33--> |
|||
{| class="wikitable" |
|||
⚫ | |||
⚫ | |||
|- |
|- |
||
| {{Button|[[Image:View-refresh.svg|x16px]] [[Image:Toolbar_flyout_arrow.svg|x16px]]}} |
|||
| {{MenuCommand|Auto Update}} |
|||
| This button opens a menu: |
|||
| If checked, the whole document will be recomputed after every sketch action. The advantage is that if you e.g. edit the sketch of a pocket, you will see the effect immediately. The disadvantage is that it takes a long time for complex documents. Thus disable the option if editing sketches gets slow. |
|||
* {{MenuCommand|Auto update}}: If checked, the whole document is recomputed after every sketch action. Not advisable for complex documents. |
|||
|} |
|} |
||
Line 48: | Line 83: | ||
<!--T:9--> |
<!--T:9--> |
||
This section will only appear if you check the '''Show section 'Advanced solver control'''' option in the [[Sketcher_Preferences|sketcher preferences]]. |
This section will only appear if you check the '''Show section 'Advanced solver control'''' option in the [[Sketcher_Preferences|sketcher preferences]]. |
||
<!--T:12--> |
|||
⚫ | |||
<!--T:10--> |
<!--T:10--> |
||
Line 53: | Line 91: | ||
<!--T:11--> |
<!--T:11--> |
||
{| class="wikitable |
{| class="wikitable mw-collapsible mw-collapsed" |
||
!style="width: 15%;"|Option |
!style="width: 15%;"|Option |
||
!style="width: 85%;"|Description |
!style="width: 85%;"|Description |
||
Line 111: | Line 149: | ||
| This button restores the default solver settings. |
| This button restores the default solver settings. |
||
|} |
|} |
||
⚫ | |||
⚫ | |||
==Constraints== <!--T:17--> |
==Constraints== <!--T:17--> |
||
<!--T: |
<!--T:34--> |
||
This section lists the constraints in the sketch. Unchecking a constraint in the list will hide it in the sketch. Constraints can be selected in the list as well as in the sketch. |
This section lists the constraints in the sketch. Unchecking a constraint in the list will hide it in the sketch. Constraints can be selected in the list as well as in the sketch. |
||
<!--T: |
<!--T:49--> |
||
Constraints can also be (un)hidden with [[Image:Sketcher_SwitchVirtualSpace.svg|16px]] [[Sketcher_SwitchVirtualSpace|Sketcher SwitchVirtualSpace]]. |
|||
<!--T:35--> |
|||
Available options: |
Available options: |
||
<!--T: |
<!--T:36--> |
||
{| class="wikitable |
{| class="wikitable" |
||
!style="width: 15%;"|Option |
!style="width: 15%;"|Option |
||
!style="width: 85%;"|Description |
!style="width: 85%;"|Description |
||
Line 151: | Line 189: | ||
: PosID can have the following values: |
: PosID can have the following values: |
||
: 0 = edge, 1 = start point, 2 = end point, 3 = center point. |
: 0 = edge, 1 = start point, 2 = end point, 3 = center point. |
||
: For example a dimension from the origin to the center of a circle that is the 2nd non-external element in the sketch will |
: For example a dimension from the origin to the center of a circle that is the 2nd non-external element in the sketch will have this extended information: |
||
: {{Incode|[(-1,1),(1,3)]}} |
: {{Incode|[(-1,1),(1,3)]}} |
||
* {{MenuCommand|Hide internal alignment (in widget)}}: If checked, constraints associated with |
* {{MenuCommand|Hide internal alignment (in widget)}}: If checked, constraints associated with internal alignments are hidden in the list. The [[Image:Sketcher_RestoreInternalAlignmentGeometry.svg|16px]] [[Sketcher_RestoreInternalAlignmentGeometry|Show/Hide internal geometry]] tool can also hide these constraints, but will also hide the internal alignments in the sketch. |
||
|- |
|- |
||
| {{MenuCommand|Context menu}} |
| {{MenuCommand|Context menu}} |
||
| |
| Right-clicking constraints selected in the list opens a context menu. The menu has the following options: |
||
* {{MenuCommand|Change value}}: Changes the value of a dimensional constraint. Only works for a single constraint. |
* {{MenuCommand|Change value}}: Changes the value of a dimensional constraint. Only works for a single constraint. You can also double click the constraint in the list, or double click its value in the [[3D_view|3D view]]. |
||
* {{MenuCommand|Toggle to/from reference}}: See [[Sketcher_ToggleDrivingConstraint|Sketcher ToggleDrivingConstraint]]. |
* {{MenuCommand|Toggle to/from reference}}: See [[Sketcher_ToggleDrivingConstraint|Sketcher ToggleDrivingConstraint]]. |
||
* {{MenuCommand|Deactivate}} or {{MenuCommand|Activate}}: See [[Sketcher_ToggleActiveConstraint|Sketcher ToggleActiveConstraint]]. |
* {{MenuCommand|Deactivate}} or {{MenuCommand|Activate}}: See [[Sketcher_ToggleActiveConstraint|Sketcher ToggleActiveConstraint]]. |
||
Line 164: | Line 202: | ||
* {{MenuCommand|Select Elements}}: See [[Sketcher_SelectElementsAssociatedWithConstraints|Sketcher SelectElementsAssociatedWithConstraints]]. |
* {{MenuCommand|Select Elements}}: See [[Sketcher_SelectElementsAssociatedWithConstraints|Sketcher SelectElementsAssociatedWithConstraints]]. |
||
* {{MenuCommand|Rename}}: Renames the constraint. |
* {{MenuCommand|Rename}}: Renames the constraint. |
||
* {{MenuCommand|Center sketch}}: Centers the 3D view around the selected |
* {{MenuCommand|Center sketch}}: Centers the 3D view around the selected constraints. |
||
* {{MenuCommand|Delete}}: Deletes the selected constrains. The {{KEY|Del}} key can also be used. |
* {{MenuCommand|Delete}}: Deletes the selected constrains. The {{KEY|Del}} key can also be used. |
||
* {{MenuCommand|Swap constraint names}}: Swaps the names of selected constraints. Only works if two constraints with user given names are selected. |
* {{MenuCommand|Swap constraint names}}: Swaps the names of selected constraints. Only works if two constraints with user given names are selected. |
||
Line 171: | Line 209: | ||
==Elements== <!--T:21--> |
==Elements== <!--T:21--> |
||
<!--T: |
<!--T:37--> |
||
This section lists the elements in the sketch. Unchecking an element in the list will hide it in the sketch. Elements can be selected in the list as well as in the sketch. |
This section lists the elements in the sketch. Unchecking an element in the list will hide it in the sketch. Elements can be selected in the list as well as in the sketch. |
||
<!--T: |
<!--T:38--> |
||
Available options: |
Available options: |
||
<!--T: |
<!--T:39--> |
||
{| class="wikitable |
{| class="wikitable" |
||
!style="width: 15%;"|Option |
!style="width: 15%;"|Option |
||
!style="width: 85%;"|Description |
!style="width: 85%;"|Description |
||
Line 202: | Line 240: | ||
| This button opens a menu: |
| This button opens a menu: |
||
* {{MenuCommand|Extended information}}: If checked, extended element information is provided. |
* {{MenuCommand|Extended information}}: If checked, extended element information is provided. |
||
: For |
: For non-external geometry the information in the list then changes from: |
||
: {{Incode|<N>-<TYPE>}} |
: {{Incode|<N>-<TYPE>}} |
||
: to: |
: to: |
||
Line 208: | Line 246: | ||
: <TYPE>: Element type. |
: <TYPE>: Element type. |
||
: <N>: A 1-based index that indicates the creation order of the element. |
: <N>: A 1-based index that indicates the creation order of the element. |
||
: <GeoID>: |
: <GeoID>: See under [[#Constraints|Constraints]]. |
||
: <VLX>: Element layer. See below. |
|||
⚫ | : |
||
|- |
|- |
||
| [[Image:Sketcher_Element_Arc_Edge.svg| |
| [[Image:Sketcher_Element_Arc_Edge.svg|24px]] [[Image:Sketcher_Element_Arc_StartingPoint.svg|24px]] [[Image:Sketcher_Element_Arc_EndPoint.svg|24px]] [[Image:Sketcher_Element_Arc_MidPoint.svg|24px]] |
||
| Each element in the list has 1 to 4 buttons organized in 4 columns. These select a specific part of the element. |
| Each element in the list has 1 to 4 buttons organized in 4 columns. These select a specific part of the element. Only applicable buttons are shown. |
||
* Button in column 1: Selects the edge of the element. |
* Button in column 1: Selects the edge of the element. |
||
* Button in column 2: Selects the start point of the element. |
* Button in column 2: Selects the start point of the element. |
||
Line 218: | Line 256: | ||
* Button in column 4: Selects the center point of the element. |
* Button in column 4: Selects the center point of the element. |
||
Clicking the text has the same effect as clicking the first available button of the element. |
Clicking the text has the same effect as clicking the first available button of the element. |
||
<!--T:45--> |
|||
[[Image:Sketcher_Dialog_Elements.png]]<br> |
|||
''In the image the edge of a line and the center of an arc have been selected.''<br> |
|||
''The line does not have a button in column 4 as it does not have a center.'' |
|||
⚫ | |||
⚫ | |||
| Right-clicking elements selected in the list opens a context menu. The menu contains the Geometric [[Sketcher_Workbench#Sketcher_constraints|constraint tools]], the Dimensional constraint tools and the following additional options: |
|||
* {{MenuCommand|Toggle construction geometry}}: See [[Sketcher_ToggleConstruction|Sketcher ToggleConstruction]]. |
|||
* {{MenuCommand|Select Constraints}}: See [[Sketcher_SelectConstraints|Sketcher SelectConstraints]]. |
|||
* {{MenuCommand|Select Origin}}: See [[Sketcher_SelectOrigin|Sketcher SelectOrigin]]. |
|||
* {{MenuCommand|Select Horizontal Axis}}: See [[Sketcher_SelectHorizontalAxis|Sketcher SelectHorizontalAxis]]. |
|||
* {{MenuCommand|Select Vertical Axis}}: See [[Sketcher_SelectVerticalAxis|Sketcher SelectVerticalAxis]]. |
|||
* {{MenuCommand|Layer}}: 3 layers are available: |
|||
** {{MenuCommand|Layer 0}}: Indicated as {{Incode|VL0}} in extended information. This is the default layer. Elements on this layer are displayed with a solid line type. |
|||
** {{MenuCommand|Layer 1}}: Indicated as {{Incode|VL1}} in extended information. Elements on this layer are displayed with a dashed line type. |
|||
** {{MenuCommand|Hidden}}: Indicated as {{Incode|VL2}} in extended information. Elements on this layer are hidden in the sketch. |
|||
⚫ | |||
* {{MenuCommand|Delete}}: Deletes the selected elements. The {{KEY|Del}} key can also be used. |
|||
|} |
|} |
||
Line 224: | Line 281: | ||
{{Docnav |
{{Docnav |
||
|[[Sketcher_EditSketch|Edit sketch]] |
|[[Sketcher_EditSketch|Edit sketch]] |
||
|[[ |
|[[Sketcher_MapSketch|Attach sketch]] |
||
|[[Sketcher_Workbench|Sketcher]] |
|[[Sketcher_Workbench|Sketcher]] |
||
|IconL=Sketcher_EditSketch.svg |
|IconL=Sketcher_EditSketch.svg |
||
|IconR= |
|IconR=Sketcher_MapSketch.svg |
||
|IconC=Workbench_Sketcher.svg |
|IconC=Workbench_Sketcher.svg |
||
}} |
}} |
Revision as of 10:21, 21 April 2024
Introduction
While a sketch is being edited, or, in other words, while a sketch is in edit mode, the Sketcher Dialog is displayed on the Task tab of the Combo view.
To put a sketch in edit mode see Sketcher EditSketch. To finish edit mode see Sketcher LeaveSketch.
The Sketcher Dialog has the following sections:
Tool parameters
Some tools add a parameters section at the top of the dialog. Available options and/or modes depend on the tool.
The parameters section of the Sketcher CreateLine tool
Solver messages
This section informs about the state of the sketch.
The possible messages are:
- Empty sketch
- Fully constrained
- Under constrained: n DoF(s)
- Redundant constraints: (#, #, #)
- Over-constrained: (#, #, #)
If a sketch is under-constrained the number of degrees of freedom (or DoFs) is indicated. Clicking the underlined text will select the under-constrained sketch elements. See Sketcher SelectElementsWithDoFs.
If a sketch has redundant constraints or is over-constrained the indices of the involved constraints are indicated. Clicking the underlined text will select them. See Sketcher SelectRedundantConstraints and Sketcher SelectConflictingConstraints.
The last two messages are displayed in red for a reason: they are warnings that should not be ignored. They indicate issues that must be addressed as they interfere with the solver.
The last three messages are not mutually exclusive. If more than one applies only the most important message, occurring lowest in the list, is displayed.
Available options:
Option | Description |
---|---|
This button opens a menu:
|
Advanced solver control
This section will only appear if you check the Show section 'Advanced solver control' option in the sketcher preferences.
Note that most of the options in this section are of no practical use. They can however help with testing and understanding the solvers.
Available options:
Option | Description |
---|---|
Default solver | The solver that is used for solving the geometry. LevenbergMarquardt and DogLeg are trust region optimization algorithms. The BFGS solver uses the Broyden–Fletcher–Goldfarb–Shanno algorithm. |
DogLeg Gauss step | This setting is only available for the solver DogLeg. It is the step type used in the DogLeg algorithm. |
Maximum iterations | If the solver needs more iterations to find a convergence to a solution, it will stop and output that it failed. |
Sketch size multiplier | If checked, the maximum iterations will be multiplied by the number of parameters. The idea is that bigger sketches would need more iterations to converge. |
Convergence | The threshold for the squared error. This error is used to determine whether a solution converges or not. |
Eps/Eps1/Tau | These settings are only available for the solver LevenbergMarquardt. You should only change something here if you fully understand how the LevenbergMarquardt solver works. |
Tolg/Tolx/Tolf | These settings are only available for the solver DogLeg. You should only change something here if you fully understand how the DogLeg solver works. |
QR Algorithm | During diagnosing the rank of the matrix is calculated which enables to further analyze the constraint system to determine if there are redundant/conflicting constraints. The rank revealing decomposition used in FreeCAD is QR. There are two algorithms: Eigen Dense QR is a dense matrix QR with full pivoting, which is the legacy proven algorithm that works very well but it is rather slow as the system grows. The Eigen Sparse QR algorithm is an optimization for sparse matrices (having lots of zeros), which is usually much faster, since FreeCAD's systems do have a lot of zeros. |
Pivot threshold | When doing a QR, values under the pivot threshold are treated as zero. |
Redundant Solver | The solver that is used during diagnosing to determine whether a group is redundant or conflicting. |
Red. Max Iterations | The same as Maximum iterations, but for the redundant solving. |
Red. Sketch size multiplier | The same as Sketch size multiplier, but for the redundant solving. |
Red. Convergence | The same as Convergence, but for the redundant solving. |
R.Eps/R.Eps1/R.Tau | The same as Eps/Eps1/Tau, but for the redundant solving. |
R.Tolg/R.Tolx/R.Tolf | The same as Tolg/Tolx/Tolf, but for the redundant solving. |
Console Debug mode | Setting to specify the verbosity of the console output. |
Solve | This button explicitly starts the solver. |
Restore Defaults | This button restores the default solver settings. |
Constraints
This section lists the constraints in the sketch. Unchecking a constraint in the list will hide it in the sketch. Constraints can be selected in the list as well as in the sketch.
Constraints can also be (un)hidden with Sketcher SwitchVirtualSpace.
Available options:
Option | Description |
---|---|
Filter | If the Filter checkbox is checked the Filter dropdown list controls which constraints are listed:
|
This button toggles the visibility of the listed constraints in the sketch. | |
This button opens a menu:
| |
Context menu | Right-clicking constraints selected in the list opens a context menu. The menu has the following options:
|
Elements
This section lists the elements in the sketch. Unchecking an element in the list will hide it in the sketch. Elements can be selected in the list as well as in the sketch.
Available options:
Option | Description |
---|---|
Filter | If the Filter checkbox is checked the Filter dropdown list controls which elements are listed:
|
This button opens a menu:
| |
Each element in the list has 1 to 4 buttons organized in 4 columns. These select a specific part of the element. Only applicable buttons are shown.
Clicking the text has the same effect as clicking the first available button of the element.
| |
Context menu | Right-clicking elements selected in the list opens a context menu. The menu contains the Geometric constraint tools, the Dimensional constraint tools and the following additional options:
|
- 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
- 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, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub