Sketcher Dialog: Difference between revisions

From FreeCAD Documentation
No edit summary
(V0.22 -> V1.0)
 
(142 intermediate revisions by 2 users not shown)
Line 5: Line 5:
{{Docnav
{{Docnav
|[[Sketcher_EditSketch|Edit sketch]]
|[[Sketcher_EditSketch|Edit sketch]]
|[[Sketcher_LeaveSketch|Leave sketch]]
|[[Sketcher_MapSketch|Attach sketch]]
|[[Sketcher_Workbench|Sketcher]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_EditSketch.svg‎‎
|IconL=Sketcher_EditSketch.svg‎‎
|IconR=Sketcher_LeaveSketch.svg
|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]]).

<!--T:40-->
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 dialog consists of the following sections:
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:7-->
<!--T:46-->
There are two solver messages options:
The possible messages are:
* Empty sketch
{| class="wikitable float-right mw-collapsible mw-collapsed"
* <span style="color:green;">Fully constrained</span>
!style="width: 33%;"|Name
* Under constrained: <span style="color:blue;text-decoration:underline;">n DoF(s)</span>
!style="width: 66%;"|Description
* <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>
| {{MenuCommand|Auto Remove Redundants}}

| 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"
!style="width: 15%;"|Option
!style="width: 85%;"|Description
|-
|-
| {{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 44: Line 82:


<!--T:9-->
<!--T:9-->
This dialog section will only appear if you check the option '''Show section 'Advanced solver control'''' 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-->
Note that most of the options in this section are of no practical use. They can however help with testing and understanding the solvers.


<!--T:10-->
<!--T:10-->
Available options:
You can specify the following:


<!--T:11-->
<!--T:11-->
{| class="wikitable float-right mw-collapsible mw-collapsed"
{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 15%;"|Option
!style="width: 66%;"|Description
!style="width: 85%;"|Description
|-
|-
| {{MenuCommand|Default solver}}
| {{MenuCommand|Default solver}}
Line 70: Line 111:
|-
|-
| {{MenuCommand|Eps/Eps1/Tau}}
| {{MenuCommand|Eps/Eps1/Tau}}
| These settings are only available for the solver '''LevenbergMarquardt'''. You should only change there something if you fully understand how the LevenbergMarquardt solver works.
| These settings are only available for the solver '''LevenbergMarquardt'''. You should only change something here if you fully understand how the LevenbergMarquardt solver works.
|-
|-
| {{MenuCommand|Tolg/Tolx/Tolf}}
| {{MenuCommand|Tolg/Tolx/Tolf}}
| These settings are only available for the solver '''DogLeg'''. You should only change there something if you fully understand how the DogLeg solver works.
| These settings are only available for the solver '''DogLeg'''. You should only change something here if you fully understand how the DogLeg solver works.
|-
|-
| {{MenuCommand|QR Algorithm}}
| {{MenuCommand|QR Algorithm}}
Line 102: Line 143:
| Setting to specify the verbosity of the console output.
| Setting to specify the verbosity of the console output.
|-
|-
| {{MenuCommand|Solve}}
| {{Button|Solve}}
| With this button the solver will explicitly started.
| This button explicitly starts the solver.
|-
|-
| {{MenuCommand|Restore Defaults}}
| {{Button|Restore Defaults}}
| With this button the default solver settings will be restored.
| This button restores the default solver settings.
|}
|}


<!--T:12-->
==Constraints== <!--T:17-->
''Note:'' Most of the solver parameters are of no practical use. They can however help testing and understanding the solvers.


==Edit controls== <!--T:13-->
<!--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.


<!--T:28-->
<!--T:49-->
Constraints can also be (un)hidden with [[Image:Sketcher_SwitchVirtualSpace.svg|16px]] [[Sketcher_SwitchVirtualSpace|Sketcher SwitchVirtualSpace]].
This dialog section can be suppressed by unchecking the option '''Show section 'Edit controls'''' in the [[Sketcher_Preferences|sketcher preferences]]. {{Version|1.0}}


<!--T:14-->
<!--T:35-->
Available options:
The edit controls are intended to improve the workflow. They can also globally set for all sketches via the [[Sketcher_Preferences#General_Settings|sketcher preferences]].


<!--T:15-->
<!--T:36-->
{| class="wikitable"
You can set the following controls:
!style="width: 15%;"|Option

!style="width: 85%;"|Description
<!--T:16-->
{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
|-
| {{Button|Filter [[Image:Toolbar_flyout_arrow.svg|x16px]]}}
| {{MenuCommand|Show Grid}}
| If the Filter checkbox is checked the Filter dropdown list controls which constraints are listed:
| If checked, a grid will be shown.
* {{MenuCommand|All}}: All constraints.
* {{MenuCommand|Geometric}}: Geometric constraints.
* {{MenuCommand|Datums}}: [[Sketcher_ToggleDrivingConstraint|Driving]] dimensional constraints. Does not work properly: all dimensional constraints are filtered.
* {{MenuCommand|Named}}: Named constraints. Does not work.
* {{MenuCommand|Reference}}: [[Sketcher_ToggleDrivingConstraint|Driven]] dimensional constraints. Does not work.
* {{MenuCommand|Selected constraints}}: Constraints selected in the sketch.
* {{MenuCommand|Associated constraints}}: Constraints associated with elements selected in the sketch.
|-
|-
| {{Button|[[Image:Std_ToggleVisibility.svg|x16px]]}}
| {{MenuCommand|Grid size}}
| This button toggles the visibility of the listed constraints in the sketch.
| The distance between two subsequent grid lines. Note that the default value of 0 mm will result in a 10 mm grid.
|-
|-
| {{Button|[[Image:Sketcher_Settings.svg|x16px]] [[Image:Toolbar_flyout_arrow.svg|x16px]]}}
| {{MenuCommand|Grid snap}}
| This button opens a menu:
| If checked, new points will snap to the nearest grid line. Note that the points have already to be close to a grid line that the snap takes effect. The distance is a fifth of the value set for {{MenuCommand|Grid size}}, so for a 10 mm grid, the snapping only occurs if the point is not more than 2 mm away from a grid line.<br/>'''Note:''' A snapped point has no coincident constraint with the grid point it snapped to.
* {{MenuCommand|Auto constraints}}: If checked, some geometric constraints are applied automatically to new elements.
* {{MenuCommand|Auto remove redundants}}: If checked, new constraints that are redundant are automatically removed.
* {{MenuCommand|Show only filtered Constraints}}: If checked, only the listed constraints are shown in the sketch.
* {{MenuCommand|Extended information (in widget)}}: If checked, extended information is added in this form:
: {{Incode|[(GeoID1,PosID1),(GeoID2,PosID2),(GeoID3,PosID3)]}}
: GeoID is a zero-based index for non-external geometry. The X axis has GeoID -1, the Y axis has GeoID -2. GeoID -3, -4 etc. are used for external geometry.
: PosID can have the following values:
: 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 have this extended information:
: {{Incode|[(-1,1),(1,3)]}}
* {{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|Auto constraints}}
| {{MenuCommand|Context menu}}
| Right-clicking constraints selected in the list opens a context menu. The menu has the following options:
| If checked, the sketcher proposes automatically sensible constraints. If you draw for example a [[Sketcher_CreatePolyline|polyline]] [[Image:Sketcher_CreatePolyline.svg|20px]] and point towards the bottom, you will see that the sketcher proposes a vertical constraint:[[Image:Constraint_Vertical.svg|20px]]. If you set now a point the drawn line segment will get the vertical 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|Avoid redundant auto constraints}}
* {{MenuCommand|Deactivate}} or {{MenuCommand|Activate}}: See [[Sketcher_ToggleActiveConstraint|Sketcher ToggleActiveConstraint]].
| If checked, the sketcher tries not to propose redundant auto constraints. This option only has an effect if also the option {{MenuCommand|Auto constraints}} is used.
* {{MenuCommand|Show constraints}}: Same as checking the constraint checkbox. But, unlike the checkbox, also works for more than one constraint.
|-
* {{MenuCommand|Hide constraints}}: Same as unchecking the constraint checkbox. Idem.
| {{MenuCommand|Rendering order}}
* {{MenuCommand|Select Elements}}: See [[Sketcher_SelectElementsAssociatedWithConstraints|Sketcher SelectElementsAssociatedWithConstraints]].
| The order how sketches are rendered. To change it, drag and drop a geometry type to the top or bottom.
* {{MenuCommand|Rename}}: Renames the constraint.
|}
* {{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.
==Constraints== <!--T:17-->
* {{MenuCommand|Swap constraint names}}: Swaps the names of selected constraints. Only works if two constraints with user given names are selected.

<!--T:18-->
This sections lists the constraints of the sketch. By unchecking a constraint in the list you can hide it.

<!--T:19-->
You can set the following options:

<!--T:20-->
{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Filter}}
| You can select what constraint types will be listed. The types are<br/>''All'': all constraints<br/> ''Normal'': constraints to normal sketch elements<br/> ''Datums'': dimensional constraints to [[Sketcher_ToggleConstruction|construction elements]]<br/>''Named'': constraints with a name<br/>''Reference'': constraints in [[Sketcher_ToggleDrivingConstraint|reference mode]]
|-
| {{MenuCommand|Hide Internal Alignment}}
| If checked, [[Sketcher_ConstrainInternalAlignment|internal alignments]] will be hidden. Currently the sketcher uses internal alignments to construct [[Sketcher_CompCreateConic|Ellipses/Arcs]] and [[Sketcher_CompCreateBSpline|B-splines]].<br/>Note: You can only hide these alignments in the constraint list. To hide them in the sketch you must use the toolbar button [[File:Sketcher_Element_Ellipse_All.png‎|24px]] ([[Sketcher_RestoreInternalAlignmentGeometry|Show/Hide internal geometry]]).
|-
| {{MenuCommand|Extended Information}}
| If checked, extended information will be added to the list in this form<br/>[(GeoID1,PosID1);(GeoID2,PosID2);(GeoID3,PosID3)]<br/>PosID can have the following values:<br/>''0'': Edge, ''1'' = starting point, ''2'' = endpoint, ''3'' = midpoint<br/>The GeoID is the number of the sketch element minus 1. The coordinate system origin has the GeoID ''-1''.<br/>For example a dimension from the origin to the center of a circle with the element number '2' will get this information: [(1,3);(-1,1)]
|}
|}


==Elements== <!--T:21-->
==Elements== <!--T:21-->


<!--T:22-->
<!--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.
In sections the sketch elements are listed and can be highlighted. If you click in the list on an element it will be highlighted with green color. Every element in the list begins with a number. The number is the order of creation in the sketch.<br/>If you keep the {{KEY|Ctrl}} key pressed you can select several elements at once. If you press the {{KEY|Z}} key you can switch to the next valid type. For example if you select a line in the list and press {{KEY|Z}} you can switch to its defining points.


<!--T:23-->
<!--T:38-->
You can set the following options:
Available options:


<!--T:24-->
<!--T:39-->
{| class="wikitable float-right mw-collapsible mw-collapsed"
{| class="wikitable"
!style="width: 33%;"|Name
!style="width: 15%;"|Option
!style="width: 66%;"|Description
!style="width: 85%;"|Description
|-
|-
| {{Button|Filter [[Image:Toolbar_flyout_arrow.svg|x16px]]}}
| {{MenuCommand|Type}}
| If the Filter checkbox is checked the Filter dropdown list controls which elements are listed:
| You can select the list selection type. If you set for example ''End point'', all elements in the list that don't have an end point (circles etc.) will get the icon [[Image:Sketcher Element SelectionTypeInvalid.svg|20px]] to indicate that you can click on them but they will not be highlighted. If you click e.g. on a line, its end point will be highlighted.<br/>You can choose between the types ''Edge'', ''Starting Point'', ''End Point'' and ''Center Point''.
* {{MenuCommand|Normal}}: Normal geometry: geometry that does not fall in the next three categories.
* {{MenuCommand|Construction}}: [[Sketcher_ToggleConstruction|Construction geometry]].
* {{MenuCommand|Internal}}: [[Sketcher_RestoreInternalAlignmentGeometry|Internal geometry]].
* {{MenuCommand|External}}: [[Sketcher_External|External geometry]].
* {{MenuCommand|All types}}: All geometry types. Specific types can be selected in the rest of the list:
** {{MenuCommand|Point}}
** {{MenuCommand|Line}}
** {{MenuCommand|Circle}}
** {{MenuCommand|Ellipse}}
** {{MenuCommand|Arc of circle}}
** {{MenuCommand|Arc of ellipse}}
** {{MenuCommand|Arc of hyperbola}}
** {{MenuCommand|Arc of parabola}}
** {{MenuCommand|B-Spline}}
|-
|-
| {{Button|[[Image:Sketcher_Settings.svg|x16px]] [[Image:Toolbar_flyout_arrow.svg|x16px]]}}
| {{MenuCommand|Mode}}
| This button opens a menu:
| You can select what sketch elements will be shown in the list, either ''All'', ''Normal'' (regular sketch elements), ''Construction'' ([[Sketcher_ToggleConstruction|construction elements]]) and ''External'' (elements from [[Sketcher_External|external geometries]]).
* {{MenuCommand|Extended information}}: If checked, extended element information is provided.
: For non-external geometry the information in the list then changes from:
: {{Incode|<N>-<TYPE>}}
: to:
: {{Incode|<TYPE>(Edge<N>#ID<GeoID>#<VLX>)[-Construction]}}
: <TYPE>: Element type.
: <N>: A 1-based index that indicates the creation order of the element.
: <GeoID>: See under [[#Constraints|Constraints]].
: <VLX>: Element layer. See below.
|-
|-
| [[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]]
| {{MenuCommand|Extended Naming}}
| 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.
| If checked, the naming in the list changes from:<br/>''<number>-type''<br/>to:<br/>''type(Edge<number>)[-Construction]''<br/>So the name gets longer but contains the information about the element mode.
* Button in column 1: Selects the edge of the element.
* Button in column 2: Selects the start point of the element.
* Button in column 3: Selects the end 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.

<!--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.''
|-
|-
| {{MenuCommand|Auto-switch to Edge}}
| {{MenuCommand|Context menu}}
| 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:
| If checked, only the {{MenuCommand|Type}} ''Edge'' will be available for the list.
* {{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.
: The rendering order of layers 0 and 1 is such that when picking coincident points in the [[3D_view|3D view]] elements on layer 0 are selected in favor of those on layer 1.
* {{MenuCommand|Delete}}: Deletes the selected elements. The {{KEY|Del}} key can also be used.
|}
|}


Line 200: Line 281:
{{Docnav
{{Docnav
|[[Sketcher_EditSketch|Edit sketch]]
|[[Sketcher_EditSketch|Edit sketch]]
|[[Sketcher_LeaveSketch|Leave sketch]]
|[[Sketcher_MapSketch|Attach sketch]]
|[[Sketcher_Workbench|Sketcher]]
|[[Sketcher_Workbench|Sketcher]]
|IconL=Sketcher_EditSketch.svg‎‎
|IconL=Sketcher_EditSketch.svg‎‎
|IconR=Sketcher_LeaveSketch.svg
|IconR=Sketcher_MapSketch.svg
|IconC=Workbench_Sketcher.svg
|IconC=Workbench_Sketcher.svg
}}
}}
Line 210: Line 291:
{{Sketcher Tools navi{{#translation:}}}}
{{Sketcher Tools navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest 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

introduced in version 1.0

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:
  • Auto update: If checked, the whole document is recomputed after every sketch action. Not advisable for complex documents.

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:
  • All: All constraints.
  • Geometric: Geometric constraints.
  • Datums: Driving dimensional constraints. Does not work properly: all dimensional constraints are filtered.
  • Named: Named constraints. Does not work.
  • Reference: Driven dimensional constraints. Does not work.
  • Selected constraints: Constraints selected in the sketch.
  • Associated constraints: Constraints associated with elements selected in the sketch.
This button toggles the visibility of the listed constraints in the sketch.
This button opens a menu:
  • Auto constraints: If checked, some geometric constraints are applied automatically to new elements.
  • Auto remove redundants: If checked, new constraints that are redundant are automatically removed.
  • Show only filtered Constraints: If checked, only the listed constraints are shown in the sketch.
  • Extended information (in widget): If checked, extended information is added in this form:
[(GeoID1,PosID1),(GeoID2,PosID2),(GeoID3,PosID3)]
GeoID is a zero-based index for non-external geometry. The X axis has GeoID -1, the Y axis has GeoID -2. GeoID -3, -4 etc. are used for external geometry.
PosID can have the following values:
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 have this extended information:
[(-1,1),(1,3)]
  • Hide internal alignment (in widget): If checked, constraints associated with internal alignments are hidden in the list. The Show/Hide internal geometry tool can also hide these constraints, but will also hide the internal alignments in the sketch.
Context menu Right-clicking constraints selected in the list opens a context menu. The menu has the following options:
  • 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.
  • Toggle to/from reference: See Sketcher ToggleDrivingConstraint.
  • Deactivate or Activate: See Sketcher ToggleActiveConstraint.
  • Show constraints: Same as checking the constraint checkbox. But, unlike the checkbox, also works for more than one constraint.
  • Hide constraints: Same as unchecking the constraint checkbox. Idem.
  • Select Elements: See Sketcher SelectElementsAssociatedWithConstraints.
  • Rename: Renames the constraint.
  • Center sketch: Centers the 3D view around the selected constraints.
  • Delete: Deletes the selected constrains. The Del key can also be used.
  • Swap constraint names: Swaps the names of selected constraints. Only works if two constraints with user given names are selected.

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:
  • Normal: Normal geometry: geometry that does not fall in the next three categories.
  • Construction: Construction geometry.
  • Internal: Internal geometry.
  • External: External geometry.
  • All types: All geometry types. Specific types can be selected in the rest of the list:
    • Point
    • Line
    • Circle
    • Ellipse
    • Arc of circle
    • Arc of ellipse
    • Arc of hyperbola
    • Arc of parabola
    • B-Spline
This button opens a menu:
  • Extended information: If checked, extended element information is provided.
For non-external geometry the information in the list then changes from:
<N>-<TYPE>
to:
<TYPE>(Edge<N>#ID<GeoID>#<VLX>)[-Construction]
<TYPE>: Element type.
<N>: A 1-based index that indicates the creation order of the element.
<GeoID>: See under Constraints.
<VLX>: Element layer. See below.
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 2: Selects the start point of the element.
  • Button in column 3: Selects the end 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.


In the image the edge of a line and the center of an arc have been selected.
The line does not have a button in column 4 as it does not have a center.

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:
  • Toggle construction geometry: See Sketcher ToggleConstruction.
  • Select Constraints: See Sketcher SelectConstraints.
  • Select Origin: See Sketcher SelectOrigin.
  • Select Horizontal Axis: See Sketcher SelectHorizontalAxis.
  • Select Vertical Axis: See Sketcher SelectVerticalAxis.
  • Layer: 3 layers are available:
    • Layer 0: Indicated as VL0 in extended information. This is the default layer. Elements on this layer are displayed with a solid line type.
    • Layer 1: Indicated as VL1 in extended information. Elements on this layer are displayed with a dashed line type.
    • Hidden: Indicated as VL2 in extended information. Elements on this layer are hidden in the sketch.
The rendering order of layers 0 and 1 is such that when picking coincident points in the 3D view elements on layer 0 are selected in favor of those on layer 1.
  • Delete: Deletes the selected elements. The Del key can also be used.