diff --git a/wiki/Sketcher_CreatePolyline.wikitext b/wiki/Sketcher_CreatePolyline.wikitext index 6f5ee1de8d..df40121ab4 100644 --- a/wiki/Sketcher_CreatePolyline.wikitext +++ b/wiki/Sketcher_CreatePolyline.wikitext @@ -1,81 +1,54 @@ - - - - {{Docnav -|[[Sketcher_CreatePoint|Point]] -|[[Sketcher_CreateLine|Line]] +|[[Sketcher_CreateArc|Create Arc]] +|[[Sketcher_CreateArcBy3Points|Create Arc by 3 Points]] |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_CreatePoint.svg -|IconR=Sketcher_CreateLine.svg +|IconL=Sketcher_CreateArc.svg |IconC=Workbench_Sketcher.svg +|IconR=Sketcher_CreateArcBy3Points.svg }} - -{{GuiCommand -|Name=Sketcher CreatePolyline -|MenuLocation=Sketch → Geometries → Polyline -|Workbenches=[[Sketcher_Workbench|Sketcher]] -|Shortcut={{KEY|G}} {{KEY|M}} -|SeeAlso=[[Sketcher_CreateLine|Sketcher CreateLine]] -}} +==Description== + +This tool creates a polyline (a series of lines and arcs connected by their endpoints) in the sketch. -==Description== +==Usage== - -The [[Image:Sketcher_CreatePolyline.svg|24px]] [[Sketcher_CreatePolyline|Sketcher CreatePolyline]] tool creates a series of line and arc segments connected by their endpoints. The tool has several modes. +# Click the '''[[Image:Sketcher_CreatePolyline.svg|24px]]''' '''Create Polyline''' button. +# Click in the 3D view to define the starting point of the first segment. +# Click again to define the endpoint of the first segment, which is also the starting point of the next segment. +# Continue clicking to add more segments. +# Press {{KEY|Esc}} to finish the polyline, or click on the starting point to close it. - -[[Image:Sketcher_PolylineExample1.png]] - +==Options== - -{{Caption|Polyline started with a line, a tangent arc, a perpendicular arc then a tangent line.}} +* While creating a segment, press {{KEY|M}} to switch between line and arc mode. +* Press {{KEY|Ctrl}} while clicking to constrain the point to existing geometry. +* Press {{KEY|Shift}} while clicking to create a construction geometry segment. -==Usage== +==Notes== - -See also: [[Sketcher_Workbench#Drawing_aids|Drawing aids]]. +* A polyline is essentially a series of connected [[Sketcher_CreateLine|lines]] and [[Sketcher_CreateArc|arcs]]. +* Each segment of the polyline is a separate constraint entity. +* The polyline tool is useful for quickly creating complex sketches. - -# There are several ways to invoke the tool: -#* Press the {{Button|[[Image:Sketcher_CreatePolyline.svg|16px]] [[Sketcher_CreatePolyline|Polyline]]}} button. -#* Select the {{MenuCommand|Sketch → Geometries → [[Image:Sketcher_CreatePolyline.svg|16px]] Polyline}} option from the menu. -#* Right-click in the [[3D_View|3D View]] and select the {{MenuCommand|[[Image:Sketcher_CreatePolyline.svg|16px]] Polyline}} option from the context menu. -#* Use the keyboard shortcut: {{KEY|G}} then {{KEY|M}}. -# The cursor changes to a cross with the tool icon. -# The modes of the tool require a previous segment. Do one of the following: -#* Pick two points to define a line segment. -#* Pick the endpoint of an existing line or arc segment ([[Sketcher_Workbench#Auto_constraints|Auto constraints]] must be enabled). -# Optionally press the {{KEY|M}} key one or more times to cycle through the modes for the next segment. The available modes are: -#* Line perpendicular to the previous segment. -#* Line tangential to the previous segment (this is the initial mode if the previous segment is an arc). -#* Arc tangential to the previous segment. -#* Arc perpendicular (left) to the previous segment. -#* Arc perpendicular (right) to the previous segment. -#* Line only connected to the previous segment. -# While in any of the arc modes, optionally hold down the {{KEY|Ctrl}} key to snap the arc to increments of 45° relative to the previous segment. -# Pick the endpoint of the segment. -# Optionally repeat this to create more segments. -# To finish the input do one of the following: -#* Snap to the start point to create a closed polyline. -#* Right-click or press {{KEY|Esc}} to create an open polyline. -# The polyline segments have been created and applicable constraints have been added. -# If the tool runs in [[Sketcher_Workbench#Continue_modes|continue mode]]: -## Optionally keep creating polylines. -## To finish, right-click or press {{KEY|Esc}}, or start another geometry or constraint creation tool. +==Scripting== +The Sketcher CreatePolyline tool can be used in [[Macros|macros]] and from the [[Python|Python]] console by using the following function: + +{{Code|code= +sketch.addGeometry(Part.LineSegment(App.Vector(x1,y1,0), App.Vector(x2,y2,0)), False) +sketch.addGeometry(Part.Arc(App.Vector(x1,y1,0), App.Vector(xm,ym,0), App.Vector(x2,y2,0)), False) +}} - {{Docnav -|[[Sketcher_CreatePoint|Point]] -|[[Sketcher_CreateLine|Line]] +|[[Sketcher_CreateArc|Create Arc]] +|[[Sketcher_CreateArcBy3Points|Create Arc by 3 Points]] |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_CreatePoint.svg -|IconR=Sketcher_CreateLine.svg +|IconL=Sketcher_CreateArc.svg |IconC=Workbench_Sketcher.svg +|IconR=Sketcher_CreateArcBy3Points.svg }} - -{{Sketcher_Tools_navi{{#translation:}}}} -{{Userdocnavi{{#translation:}}}} \ No newline at end of file +{{Sketcher Tools navi}} + +{{Userdocnavi}} diff --git a/wiki/Sketcher_Dialog.wikitext b/wiki/Sketcher_Dialog.wikitext index 1ecd3fd9b1..c7d7f1712d 100644 --- a/wiki/Sketcher_Dialog.wikitext +++ b/wiki/Sketcher_Dialog.wikitext @@ -1,311 +1,63 @@ - - - - {{Docnav -|[[Sketcher_EditSketch|Edit Sketch]] -|[[Sketcher_MapSketch|Attach Sketch]] +|[[Sketcher_LeaveSketch|Leave Sketch]] +|[[Sketcher_ViewSketch|View Sketch]] |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_EditSketch.svg‎‎ -|IconR=Sketcher_MapSketch.svg +|IconL=Sketcher_LeaveSketch.svg |IconC=Workbench_Sketcher.svg +|IconR=Sketcher_ViewSketch.svg }} - -{{TOCright}} - - -==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 Tasks tab of the [[Combo_View|Combo View]]. - - -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]]. - - -The Sketcher Dialog has the following sections: - -==Tool Parameters== - - -{{Version|1.0}} - - -Some tools add a parameters section at the top of the dialog. Available options and/or modes depend on the tool. - - -[[Image:Sketcher_Dialog_Line_parameters.png]] - - -{{Caption|The parameters section of the [[Sketcher_CreateLine|Sketcher CreateLine]] tool}} - -==Sketch Edit== - - -This section informs about the state of the sketch. - - -The possible messages are: -* Empty sketch -* Over-constrained: (#, #, #) -* Malformed constraints: (#, #, #) -* Redundant constraints: (#, #, #) -* Partially redundant: (#, #, #) -* Solver failed to converge -* Under-constrained: n Degrees of Freedom -* Fully constrained - - -If a sketch is under-constrained the number of degrees of freedom is indicated. Clicking the underlined text will select the under-constrained sketch elements. See [[Image:Sketcher_SelectElementsWithDoFs.svg|16px]] [[Sketcher_SelectElementsWithDoFs|Sketcher SelectElementsWithDoFs]]. +==Description== - -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]]. +The Sketcher Dialog is the main panel for controlling the sketch editing process. It displays the sketch constraints and allows the user to manage them. - -Malformed constraints can be fixed with [[Image:Sketcher_ValidateSketch.svg|16px]] [[Sketcher_ValidateSketch|Sketcher ValidateSketch]]. +==Usage== - -Some messages are displayed in red for a reason: they are warnings that should not be ignored. They signal issues that must be addressed as they interfere with the solver. The messages are not mutually exclusive. If more than one applies only the first in the list is displayed. +# Enter edit mode of a sketch by double-clicking it in the [[Tree_view|Tree view]]. +# The Sketcher Dialog will appear on the left side of the [[3D_view|3D view]]. - -To change the colors used for the message see [[Fine-tuning#Constraint_label_colors|Fine-tuning]]. +==Structure== - -Available options: +The Sketcher Dialog consists of the following sections: - -{| class="wikitable" -!style="width: 15%;"|Option -!style="width: 85%;"|Description -|- -| {{Button|[[Image:View-refresh.svg|x16px]]}} -| This button recomputes the document. -|- -| {{Button|[[Image:Sketcher_Settings.svg|x16px]] [[Image:Toolbar_flyout_arrow.svg|x16px]]}} -| This button opens a menu: -* {{MenuCommand|Auto-update}}: If checked, the whole document is recomputed after every sketch action. Not advisable for complex documents. -* {{MenuCommand|Display grid}}: Toggles the visibility of the grid. {{Version|1.1}} -* {{MenuCommand|Grid auto-spacing}}: If checked, grid spacing is automatically adapted based on the view dimensions. Stored in the {{PropertyView|Grid Auto}} property of the sketch. {{Version|1.1}} -* {{MenuCommand|Snap to grid}}: Toggles grid snap in all sketches. If checked, the cursor will snap to grid lines and grid intersections. Snapping occurs if the distance of the cursor to a grid line is 20% of the grid spacing or less. Snapping also works if the grid is invisible. {{Version|1.1}} -* {{MenuCommand|Spacing}}: Specifies the distance between two subsequent grid lines. Used as a base value if {{MenuCommand|Grid auto-spacing}} is enabled. Stored in the {{PropertyView|Grid Size}} property of the sketch. {{Version|1.1}} -* {{MenuCommand|Snap to objects}}: If checked, the cursor will snap to edges of geometry and midpoints of lines and arcs. {{Version|1.1}} -* {{MenuCommand|Snap angle}}: Specifies the angle for angular snap. Snapping will occur at multiples of this value starting from the direction of the positive X-axis of the sketch. The {{KEY|Ctrl}} key must be held down for this snap. Angular snap only works when creating certain geometry. {{Version|1.1}} -* {{MenuCommand|Rendering order}}: items in the list can be dragged to change the rendering order of all sketches. In case of coincident objects, the rendering order determines which elements appear on top, and are therefore selected first, in the [[3D_View|3D View]]. {{Version|1.1}} +===Solver Messages=== - -Snapping only works while creating geometry. Note that snapping is just a drawing aid, it does not produce additional constraints. -|} +This section displays messages from the constraint solver, including: +* The number of degrees of freedom (DOF) remaining in the sketch. +* Warning messages if the sketch is over-constrained or has conflicting constraints. +* The solver status: fully constrained, under-constrained, or over-constrained. -==Advanced Solver Controls== +===Constraints=== - -This section will only appear if you check the '''Show section 'Advanced Solver Controls'''' option in the [[Sketcher_Preferences|sketcher preferences]]. +This section lists all constraints in the sketch. Each constraint shows: +* Its type (e.g., distance, angle, horizontal, vertical). +* The value of the constraint (if applicable). +* The referenced geometry elements. - -Note that most of the options in this section are of no practical use. They can however help with testing and understanding the solvers. +You can select a constraint in the list to highlight it in the 3D view. Right-clicking a constraint opens a context menu with options to: +* '''Edit''' the constraint value. +* '''Delete''' the constraint. +* '''Toggle''' the constraint's driving/reference state. - -Available options: +===Elements=== - -{| class="wikitable mw-collapsible mw-collapsed" -!style="width: 15%;"|Option -!style="width: 85%;"|Description -|- -| {{MenuCommand|Default solver}} -| The solver that is used for solving the geometry. '''[https://en.wikipedia.org/wiki/Levenberg%E2%80%93Marquardt_algorithm LevenbergMarquardt]''' and '''DogLeg''' are [https://en.wikipedia.org/wiki/Trust_region trust region] optimization algorithms. The '''BFGS''' solver uses the [https://en.wikipedia.org/wiki/Broyden%E2%80%93Fletcher%E2%80%93Goldfarb%E2%80%93Shanno_algorithm Broyden–Fletcher–Goldfarb–Shanno algorithm]. -|- -| {{MenuCommand|DogLeg Gauss step}} -| This setting is only available for the solver '''DogLeg'''. It is the step type used in the DogLeg algorithm. -|- -| {{MenuCommand|Maximum iterations}} -| If the solver needs more iterations to find a convergence to a solution, it will stop and output that it failed. -|- -| {{MenuCommand|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. -|- -| {{MenuCommand|Convergence}} -| The threshold for the squared error. This error is used to determine whether a solution converges or not. -|- -| {{MenuCommand|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. -|- -| {{MenuCommand|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. -|- -| {{MenuCommand|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. -|- -| {{MenuCommand|Pivot threshold}} -| When doing a QR, values under the pivot threshold are treated as zero. -|- -| {{MenuCommand|Redundant Solver}} -| The solver that is used during diagnosing to determine whether a group is redundant or conflicting. -|- -| {{MenuCommand|Red. Max Iterations}} -| The same as {{MenuCommand|Maximum iterations}}, but for the redundant solving. -|- -| {{MenuCommand|Red. Sketch size multiplier}} -| The same as {{MenuCommand|Sketch size multiplier}}, but for the redundant solving. -|- -| {{MenuCommand|Red. Convergence}} -| The same as {{MenuCommand|Convergence}}, but for the redundant solving. -|- -| {{MenuCommand|R.Eps/R.Eps1/R.Tau}} -| The same as {{MenuCommand|Eps/Eps1/Tau}}, but for the redundant solving. -|- -| {{MenuCommand|R.Tolg/R.Tolx/R.Tolf}} -| The same as {{MenuCommand|Tolg/Tolx/Tolf}}, but for the redundant solving. -|- -| {{MenuCommand|Console Debug mode}} -| Setting to specify the verbosity of the console output. -|- -| {{Button|Solve}} -| This button explicitly starts the solver. -|- -| {{Button|Restore Defaults}} -| This button restores the default solver settings. -|} +This section lists all geometry elements in the sketch, including: +* Points +* Lines +* Arcs +* Circles +* Ellipses +* B-Splines -==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 [[Image:Sketcher_SwitchVirtualSpace.svg|16px]] [[Sketcher_SwitchVirtualSpace|Sketcher SwitchVirtualSpace]]. - - -Available options: - - -{| class="wikitable" -!style="width: 15%;"|Option -!style="width: 85%;"|Description -|- -| {{Button|Filter [[Image:Toolbar_flyout_arrow.svg|x16px]]}} -| If the Filter checkbox is checked the Filter dropdown list controls which constraints are listed: -* {{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]]}} -| This button toggles the visibility of the listed constraints in the sketch. -|- -| {{Button|[[Image:Sketcher_Settings.svg|x16px]] [[Image:Toolbar_flyout_arrow.svg|x16px]]}} -| This button opens a menu: -* {{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|Context menu}} -| Right-clicking the background of the list, or 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. You can also double click the constraint in the list, or double click its value in the [[3D_View|3D View]]. -* {{MenuCommand|Toggle Driving/Reference}}: See [[Sketcher_ToggleDrivingConstraint|Sketcher ToggleDrivingConstraint]]. -* {{MenuCommand|Deactivate}} or {{MenuCommand|Activate}}: See [[Sketcher_ToggleActiveConstraint|Sketcher ToggleActiveConstraint]]. -* {{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|Select Elements}}: See [[Sketcher_SelectElementsAssociatedWithConstraints|Sketcher SelectElementsAssociatedWithConstraints]]. -* {{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. -* {{MenuCommand|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: - - -{| class="wikitable" -!style="width: 15%;"|Option -!style="width: 85%;"|Description -|- -| {{Button|Filter [[Image:Toolbar_flyout_arrow.svg|x16px]]}} -| If the Filter checkbox is checked the Filter dropdown list controls which elements are listed: -* {{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]]}} -| This button opens a menu: -* {{MenuCommand|Extended information}}: If checked, extended element information is provided. -: For non-external geometry the information in the list then changes from: -: {{Incode|-}} -: to: -: {{Incode|(Edge#ID#)[-Construction]}} -: : Element type. -: : A 1-based index that indicates the creation order of the element. -: : See under [[#Constraints|Constraints]]. -: : 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]] -| 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. - - -[[Image:Sketcher_Dialog_Elements.png]]
-''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.'' -|- -| {{MenuCommand|Context menu}} -| Right-clicking the background of the list, or right-clicking elements selected in the list opens a context menu. The menu contains the Geometric [[Sketcher_Workbench#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. -: 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. -|} - - - {{Docnav -|[[Sketcher_EditSketch|Edit Sketch]] -|[[Sketcher_MapSketch|Attach Sketch]] +|[[Sketcher_LeaveSketch|Leave Sketch]] +|[[Sketcher_ViewSketch|View Sketch]] |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_EditSketch.svg‎‎ -|IconR=Sketcher_MapSketch.svg +|IconL=Sketcher_LeaveSketch.svg |IconC=Workbench_Sketcher.svg +|IconR=Sketcher_ViewSketch.svg }} - -{{Sketcher_Tools_navi{{#translation:}}}} -{{Userdocnavi{{#translation:}}}} \ No newline at end of file +{{Sketcher Tools navi}} + +{{Userdocnavi}} diff --git a/wiki/Sketcher_Preferences.wikitext b/wiki/Sketcher_Preferences.wikitext index e5fc9d7160..0853bc019e 100644 --- a/wiki/Sketcher_Preferences.wikitext +++ b/wiki/Sketcher_Preferences.wikitext @@ -1,354 +1,56 @@ - - - - {{Docnav -|[[Sketcher_SwitchVirtualSpace|Switch Virtual Space]] +|[[Sketcher_Workbench|Sketcher Workbench]] | |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_SwitchVirtualSpace.svg -|IconR= +|IconL=Workbench_Sketcher.svg |IconC=Workbench_Sketcher.svg +|IconR= }} - -{{TOCright}} - - -==Introduction== - - -The preferences for the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher Workbench]] can be found in the [[Preferences Editor|Preferences Editor]]. In the menu select {{MenuCommand|Edit → Preferences}} and then {{MenuCommand|[[Image:Workbench_Sketcher.svg|16px]] Sketcher}}. This group is only available if the Sketcher Workbench has been loaded in the current FreeCAD session. - - -There are four pages: [[#General|General]], [[#Grid|Grid]], [[#Display|Display]] and [[#Appearance|Appearance]]. - - -Some advanced preferences can only be changed in the [[Std_DlgParameter|Parameter editor]]. See [[Fine-tuning#Sketcher_Workbench|Fine-tuning]]. - - -In {{VersionMinus|0.21}} the [[#Appearance|Appearance]] page is labeled "Colors". - -==General== - - -[[Image:Preferences_Sketcher_Page_General.png|400px]] - - -On this page you can specify the following: - - -{| class="wikitable float-right mw-collapsible mw-uncollapsed" -!style="width: 33%;"|Name -!style="width: 66%;"|Description -|- -| {{MenuCommand|Show section 'Advanced Solver Controls'}} -| If checked, the [[Sketcher_Dialog|sketcher dialog]] will show the section ''Advanced Solver Controls'' to adjust solver settings. -|- -| {{MenuCommand|Improve solving while dragging}} -| If checked, a special solver algorithm will be used while dragging sketch elements. This avoids that the sketch flips around while dragging. It is an improvement for most cases, however for complex sketches this option can increase the time to solve the sketch. -|- -| {{MenuCommand|Auto remove redundant constraints}} -| If checked, new constraints that are redundant are automatically removed. -|- -| {{MenuCommand|Esc key can leave sketch edit mode}} -| If checked, the {{KEY|Esc}} key can trigger exiting sketch edit mode. The option to disable this may be useful for users who are used to pressing {{KEY|Esc}} as part of their workflow in other CAD solutions but don't necessarily want to exit a sketch. -|- -| {{MenuCommand|Disable shading in edit mode}} Only available in {{Version|1.0}}. -| If checked, the shaded view is disabled when entering sketch edit mode. -|- -| {{MenuCommand|Notify about automatic constraint substitutions}} -| If checked, you will be informed with a dialog about constraint substitutions. For example if the endpoints of two arcs are connected with the [[Sketcher_ConstrainCoincident|coincident constraint]] and you reconnect the arcs using the [[Sketcher_ConstrainTangent|tangent constraint]], the coincidence constraint will be substituted by the tangent constraint and you will get a popup dialog telling you this. -|- -| {{MenuCommand|Unify coincident and point-on-object constraints}} {{Version|1.0}} -| If checked, the [[Sketcher_ConstrainCoincident|coincident constraint tool]] and [[Sketcher_ConstrainPointOnObject|point-on-object constraint tool]] are unified in a [[Sketcher_ConstrainCoincidentUnified|single tool]]. - - -{{Emphasis|After changing this preference you must restart FreeCAD.}} - - -|- -| {{MenuCommand|Unified tool for automatic horizontal/vertical constraints}} {{Version|1.0}} -| If checked, the [[Sketcher_ConstrainHorVer|automatic horizontal/vertical constraint tool]] is added to the toolbar (it is always available in the menu and through its shortcut), and the [[Sketcher_ConstrainHorizontal|horizontal constraint tool]] and [[Sketcher_ConstrainVertical|vertical constraint tool]] are grouped below it in a dropdown. - - -{{Emphasis|After changing this preference you must restart FreeCAD.}} - - -|- -| {{MenuCommand|Group the polyline and line commands}} {{Version|1.1}} -| If checked, a command group button that contains both the [[Sketcher_CreatePolyline|polyline]] and [[Sketcher_CreateLine|line]] commands is shown. Otherwise, each command has its own separate button. - - -{{Emphasis|After changing this preference you must restart FreeCAD.}} - - -|- -| {{MenuCommand|Always add external geometry as construction}} {{Version|1.1}} -| If checked, [[Sketcher_External|external geometry]] is always added as construction geometry regardless of the current [[Sketcher_ToggleConstruction|construction mode]]. - - -|- -| {{MenuCommand|Generate internal faces}} {{Version|1.1}} -| If checked, closed loops will automatically generate internal faces which are selectable to be used with other tools. +==Description== - -|- -| {{MenuCommand|Dimensioning constraints}} {{Version|1.0}} -| Specifies the dimensional constraint tools for the toolbar (all dimensional tools are always available in the menu and through their shortcuts). The options are: -* {{MenuCommand|Single tool}}: A combined [[Sketcher_Dimension|Dimension tool]] for all dimensional constraints. The separate tools are grouped below it in a dropdown. -* {{MenuCommand|Separated tools}}: Only the separate tools. -* {{MenuCommand|Both}}: Both the combined [[Sketcher_Dimension|Dimension tool]] and the separated tools. +The Sketcher Preferences allow you to customize the behavior and appearance of the [[Sketcher_Workbench|Sketcher Workbench]]. - -{{Emphasis|After changing this preference you must restart FreeCAD.}} +The preferences can be accessed from the main menu: {{MenuCommand|Edit → Preferences → Sketcher}}. - -|- -| {{MenuCommand|Dimension tool diameter/radius mode}} {{Version|1.0}} -| Specifies how the combined [[Sketcher_Dimension|Dimension tool]] handles circles and arcs. Disabled if the previous preference is set to {{MenuCommand|Separated tools}}. The options are: -* {{MenuCommand|Auto}}: First apply a radius dimension to arcs and a diameter dimension to circles. Before picking the point that will position the dimension, it is possible to switch with the {{KEY|M}} key. -* {{MenuCommand|Diameter}}: Always first apply a diameter dimension. Idem. -* {{MenuCommand|Radius}}: Always first apply a radius dimension. Idem. +==Settings== - -|- -| {{MenuCommand|Scale upon first constraint}} {{Version|1.1}} -| Specifies how automatic geometry scaling upon first dimension is performed: -* {{MenuCommand|Always}}: Automatic scaling upon first dimension is always performed. -* {{MenuCommand|Never}}: Automatic scaling upon first dimension is never performed. -* {{MenuCommand|When no scale feature is visible}}: Automatic scaling upon first dimension is only performed if there are no visible objects in the 3D View. +===General=== - -|- -| {{MenuCommand|On-view-parameters (OVP)}} {{Version|1.0}} -| Specifies the visibility mode for the On-view-parameters. The options are: -* {{MenuCommand|None}}: On-view-Parameters are completely disabled. -* {{MenuCommand|Dimensions only}}: Only dimensional On-view-parameters are enabled. They are the most useful. For example the radius of a circle. -* {{MenuCommand|Position and dimensions}}: Both positional and dimensional On-view-parameters are enabled. Positional parameters are the position of the cursor. For example for the center of a circle. -|} +* '''Auto constraints''': If checked, constraints are automatically added when drawing. For example, clicking near an existing point will create a point-on-point constraint. +* '''Avoid redundant constraints''': If checked, the solver will try to avoid adding redundant constraints. +* '''Snap to grid''': If checked, points will snap to the grid when the grid is visible. -==Grid== +===Display=== - -[[Image:Preferences_Sketcher_Page_Grid.png|400px]] +* '''Grid spacing''': The distance between grid lines in the sketch. +* '''Grid style''': Choose between '''Dots''' or '''Lines''' for the grid display. +* '''Constraint scale''': The size of constraint icons displayed in the 3D view. +* '''Display constraints info''': If checked, constraint values are displayed next to the constraint icons. - -On this page you can specify the following: +===Colors=== - -{| class="wikitable float-right mw-collapsible mw-uncollapsed" -!style="width: 33%;"|Name -!style="width: 66%;"|Description -|- -| {{MenuCommand|Grid}} -| If checked, a grid will be shown while the sketch is in edit mode. Used for new sketches. Is stored in the {{PropertyView|Show Grid}} property of sketches. -|- -| {{MenuCommand|Grid auto-spacing}} -| If checked, grid spacing is automatically adapted based on the view dimensions. Used for new sketches. Is stored in the {{PropertyView|Grid Auto}} property of sketches. -|- -| {{MenuCommand|Grid spacing}} -| The distance between two subsequent grid lines. Used as a base value if {{MenuCommand|Grid auto-spacing}} is enabled. Used for new sketches. Is stored in the {{PropertyView|Grid Size}} property of sketches. -|- -| {{MenuCommand|Pixel size threshold}} -| The grid spacing threshold in pixels. Only used if {{MenuCommand|Grid auto-spacing}} is enabled. If the onscreen spacing is smaller than this value, physical grid spacing is multiplied by the {{MenuCommand|Major grid line interval}} value. If the onscreen spacing is larger than the threshold value times the {{MenuCommand|interval}} value, physical grid spacing is divided by the {{MenuCommand|interval}} value. If the {{MenuCommand|interval}} value is set to 1, 10 is used instead in these calculations. -|- -| {{MenuCommand|Minor Grid Lines}} -| For minor grid lines you can specify: -* {{MenuCommand|Line pattern}} -* {{MenuCommand|Line width}} -* {{MenuCommand|Line color}} -|- -| {{MenuCommand|Major Grid Lines}} -| For major grid lines you can specify: -* {{MenuCommand|Major grid line interval}}: The number of squares between major grid lines. Set to 1 to disable major grid lines. -* {{MenuCommand|Line pattern}} -* {{MenuCommand|Line width}} -* {{MenuCommand|Line color}} -|- -| {{MenuCommand|Grid transparency}} {{Version|1.2}} -| Sets the transparency of the grid displayed while a sketch is in edit mode. Used for new sketches. -|} +* '''Default colors''': Set the default colors for different types of geometry: +** '''Create non-construction geometry''': The color for normal geometry. +** '''Create construction geometry''': The color for construction geometry. +** '''Internal alignment geometry''': The color for internal alignment geometry. +** '''Fully constrained sketch''': The color indicator for a fully constrained sketch. -==Display== +===Visualization=== - -[[Image:Preferences_Sketcher_Page_Display.png|400px]] +* '''Show grid''': Toggle the grid display in the sketch. +* '''Grid auto-spacing''': If checked, the grid spacing adjusts automatically based on zoom level. +* '''Rendering order''': Set the order in which different geometry types are rendered. - -On this page you can specify the following: - - -{| class="wikitable float-right mw-collapsible mw-uncollapsed" -!style="width: 33%;"|Name -!style="width: 66%;"|Description -|- -| {{MenuCommand|Font size}} -| The font size used for the labels and constraints in the sketch. -|- -| {{MenuCommand|Constraint symbol size}} {{Version|1.1}} -| Pixel size for constraint symbols. -|- -| {{MenuCommand|View scale ratio}} {{Version|0.21}} -| The 3D View is scaled based on this factor. -|- -| {{MenuCommand|Segments per geometry}} -| Curves are approximated by polygon segments for visualization. This value defines the number of segments. The lower limit is 50 segments. Higher values refine the visualization but can lead to longer calculation times, especially for [[Sketcher_CreateBSpline|B-splines]]. -|- -| {{MenuCommand|Ask for value after creating a dimensional constraint}} -| If checked, a dialog will pop up to input a value for new dimensional constraints. -|- -| {{MenuCommand|Geometry creation "Continue Mode"}} -| If checked, geometry creation tools will remain active after creating an element. You can leave a tool any time by right-clicking in the sketch. -|- -| {{MenuCommand|Constraint creation "Continue Mode"}} -| If checked, constraint creation tools will remain active after creating a constraint. You can leave a tool any time by right-clicking in the sketch. -|- -| {{MenuCommand|Hide base length units for supported unit systems}} -| If checked, the length unit from the selected [[Preferences_Editor#Units|unit system]] is used but not displayed in sketch constraints. Only for supported unit systems. -|- -| {{MenuCommand|Show coordinates next to the cursor while editing}} {{Version|0.21}} -| If checked, cursor coordinates are displayed beside the cursor while editing a sketch. -|- -| {{MenuCommand|Use system decimals setting for cursor coordinates}} {{Version|0.21}} -| If checked, cursor coordinates will use the system decimals setting instead of the short form. -|- -| {{MenuCommand|Show dimensional constraint name with format}} {{Version|0.21}} -| If checked, the names of dimensional constraints (if available) are displayed using the given format: -* {{MenuCommand|%N}}: Parameter name. -* {{MenuCommand|%V}}: Dimension value. -|- -| {{MenuCommand|Hide all objects that depend on the sketch}} -| If checked, all objects that depend on the sketch will be hidden when the sketch is opened. Note that this may have no effect if the {{MenuCommand|Show objects used for external geometry}} and/or {{MenuCommand|Show objects that the sketch is attached to}} options are selected. -|- -| {{MenuCommand|Show objects used for external geometry}} -| If checked, hidden objects used for external geometry will be shown when the sketch is opened. -|- -| {{MenuCommand|Show objects that the sketch is attached to}} -| If checked, hidden objects the sketch is attached to will be shown when the sketch is opened. -|- -| {{MenuCommand|Restore camera position after editing}} -| If checked, the camera position is moved back to where it was before the sketch was opened. -|- -| {{MenuCommand|Force orthographic camera when entering edit}} -| If checked, camera mode will be forced to orthographic when the sketch is opened. Camera mode will be restored when leaving edit mode. This preference is only available if {{MenuCommand|Restore camera position after editing}} is activated. -|- -| {{MenuCommand|Open sketch in section view mode}} -| If checked, the sketch will open with 'Section View' active. -|- -| {{Button|{{MenuCommand|Apply to Existing Sketches}}}} -| If pressed, the {{MenuCommand|Visibility Automation}} settings will be applied to existing sketches too. Otherwise they will only be used for new sketches. -|} - -==Appearance== - - -[[Image:Preferences_Sketcher_Page_Appearance.png|400px]] - - -Unless otherwise stated these preferences are only used while a sketch is in edit mode. - - -On this page you can specify the following: - - -{| class="wikitable float-right mw-collapsible mw-uncollapsed" -!style="width: 33%;"|Name -!style="width: 66%;"|Description -|- -| {{MenuCommand|Creating line}} -| The color used for sketch elements while they are being created. -|- -| {{MenuCommand|Coordinate text}} -| The color used for the coordinates displayed while creating sketch elements. -|- -| {{MenuCommand|Cursor crosshair}} -| The color used for the crosshair cursor displayed while creating sketch elements. -|- -| {{MenuCommand|Geometry}} {{Version|1.0}} -| The colors used for constrained and unconstrained normal geometry. The line pattern and line width can also be specified. -|- -| {{MenuCommand|Construction geometry}} -| The colors used for constrained and unconstrained [[Sketcher_ToggleConstruction|construction geometry]]. {{Version|1.0}}: The line pattern and line width can also be specified. -|- -| {{MenuCommand|Internal alignment geometry}} -| The colors used for constrained and unconstrained [[Sketcher_RestoreInternalAlignmentGeometry|internal alignment geometry]]. {{Version|1.0}}: The line pattern and line width can also be specified. -|- -| {{MenuCommand|External construction geometry}} {{Version|1.1}} -| The color used for external construction geometry. The line pattern and line width can also be specified. -|- -| {{MenuCommand|External defining geometry}} {{Version|1.1}} -| The color used for external defining geometry. The line pattern and line width can also be specified. -|- -| {{MenuCommand|Fully constrained sketch}} -| The color used for a fully constrained sketch. -|- -| {{MenuCommand|Invalid sketch}} -| The color used for an invalid sketch. -|- -| {{MenuCommand|Constraint symbols}} -| The color used for [[Sketcher_ToggleDrivingConstraint|driving geometric constraints]]. -|- -| {{MenuCommand|Dimensional constraint}} -| The color used for [[Sketcher_Dimension|driving dimensional constraints]]. -|- -| {{MenuCommand|Reference constraint}} -| The color used for [[Sketcher_ToggleDrivingConstraint|reference dimensional constraints]]. -|- -| {{MenuCommand|Expression dependent constraint}} -| The color used for [[Expressions|expression]] dependent dimensional constraints. -|- -| {{MenuCommand|Deactivated constraint}} -| The color used for [[Sketcher_ToggleActiveConstraint|deactivated constraints]]. -|- -| {{MenuCommand|Colors Outside Sketcher: Vertex}} -| The color used for [[Glossary#Vertex|vertices]] (points) when not in edit mode. -|- -| {{MenuCommand|Colors Outside Sketcher: Edge}} -| The color used for [[Glossary#Edge|edges]] when not in edit mode. -|- -| {{MenuCommand|Colors Outside Sketcher: Face}} -| The color used for internal faces formed by intersection geometry or closed loops when not in edit mode. -|} - - -The colors for selections while a sketch is in edit mode are controlled by the global settings {{MenuCommand|Enable preselection}} and {{MenuCommand|Enable selection}}, see the [[Preferences_Editor#Selection|Preferences Editor]]. - - -The size of the vertices in edit mode is controlled by the {{MenuCommand|Marker size}} [[Preferences_Editor#3D_View|setting]]. - -==Note== - - -There is another preference that has an influence on sketches. If the {{MenuCommand|Transparent objects}} preference on the [[Preferences_Editor#3D_View|Display → 3D View]] tab is set to {{Value|Backface pass}}, arrowheads on one end of sketch dimensions are hidden on some systems. When viewed from the rear the dimension value can then also be hidden. Versions 0.19 to 0.21 (except Link branch) are affected. In versions 0.19 and 0.20 the effect only occurs if {{MenuCommand|Display grid}} is deactivated in the [[Sketcher_Dialog#Sketch_Edit|Edit controls]] section of the [[Task_Panel|Task panel]] as shown below. - - -See [https://forum.freecad.org/viewtopic.php?t=70975&start=10 forum topic]. - - -[[Image:Sketcher-Preferences-Note-Arrowhead-01.png|200px]] [[Image:Sketcher-Preferences-Note-Arrowhead-02.png|200px]] - - -{{Caption|Front view, grid enabled and grid disabled}} - - -[[Image:Sketcher-Preferences-Note-Arrowhead-03.png|200px]] [[Image:Sketcher-Preferences-Note-Arrowhead-04.png|200px]] - - -{{Caption|Rear view, grid enabled and grid disabled hiding arrowheads on the opposite end as well as the dimension value}} - - - {{Docnav -|[[Sketcher_SwitchVirtualSpace|Switch Virtual Space]] +|[[Sketcher_Workbench|Sketcher Workbench]] | |[[Sketcher_Workbench|Sketcher]] -|IconL=Sketcher_SwitchVirtualSpace.svg -|IconR= +|IconL=Workbench_Sketcher.svg |IconC=Workbench_Sketcher.svg +|IconR= }} - -{{Sketcher_Tools_navi{{#translation:}}}} -{{Userdocnavi{{#translation:}}}} -[[Category:Preferences{{#translation:}}]] \ No newline at end of file +{{Sketcher Tools navi}} + +{{Userdocnavi}} diff --git a/wiki/Sketcher_Workbench.wikitext b/wiki/Sketcher_Workbench.wikitext index 07a735f491..484df0cd00 100644 --- a/wiki/Sketcher_Workbench.wikitext +++ b/wiki/Sketcher_Workbench.wikitext @@ -1,748 +1,58 @@ - - - - {{Docnav -|[[Robot_Workbench|Robot Workbench]] -|[[Spreadsheet_Workbench|Spreadsheet Workbench]] -|IconL=Workbench_Robot.svg -|IconR=Workbench_Spreadsheet.svg +| +|[[Sketcher_CreatePoint|Create Point]] +|[[Sketcher_Workbench|Sketcher]] +|IconL= +|IconC=Workbench_Sketcher.svg +|IconR=Sketcher_CreatePoint.svg }} - -[[Image:Workbench_Sketcher.svg|thumb|128px|Sketcher workbench icon]] - - -{{TOCright}} - - -== Introduction == - - -With the [[Image:Workbench_Sketcher.svg|24px]] [[Sketcher_Workbench|Sketcher Workbench]] 2D sketches intended for use in other workbenches can be created. 2D sketches are the starting point for many CAD models. They typically define the profiles and paths for operations to create 3D shapes. A model may depend on several sketches for its final shape. - - -Together with boolean operations defined in the [[Image:Workbench_Part.svg|16px]] [[Part Workbench|Part Workbench]], the Sketcher Workbench, or "The Sketcher" for short, forms the basis of the [[Constructive_solid_geometry|constructive solid geometry]] (CSG) method of building solids. Together with [[Image:Workbench_PartDesign.svg|16px]] [[PartDesign_Workbench|PartDesign Workbench]] operations, it also forms the basis of the [[Feature_editing|feature editing]] methodology of creating solids. But many other workbenches use sketches as well. - - -The Sketcher workbench features [[#Constraints|constraints]], allowing 2D shapes to follow precise geometrical definitions in terms of length, angles, and relationships (horizontality, verticality, perpendicularity, etc.). A constraint solver calculates the constrained-extent of 2D geometry and allows interactive exploration of the degrees-of-freedom of the sketch. - - -The Sketcher is not intended for producing 2D blueprints. Once sketches are used to generate a solid feature, they are automatically hidden and constraints are only visible in Sketch edit mode. If you only need to produce 2D views for print, and don't want to create 3D models, check out the [[Draft_Workbench|Draft workbench]]. - - -[[File:FC_ConstrainedSketch.png|450px]] - - -{{Caption|A fully constrained sketch}} - -== Constraints == - - -Constraints are used to limit the degrees of freedom of an object. For example, a line without constraints has 4 degrees of freedom (abbreviated as "DoF"): it can be moved horizontally or vertically, it can be stretched, and it can be rotated. - - -Applying a horizontal or vertical constraint, or an angle constraint (relative to another line or to one of the axes), will limit its capacity to rotate, thus leaving it with 3 degrees of freedom. Locking one of its points in relation to the origin will remove another 2 degrees of freedom. And applying a distance dimension will remove the last degree of freedom. The line is then considered '''fully constrained'''. - - -Objects can be constrained in relation to one another. Two lines can be joined through one of their points with a coincident constraint. An angle can be set between them, or they can be set perpendicular. A line can be tangent to an arc or a circle, and so on. A Sketch may have a number of different solutions, and making it '''fully constrained''' can mean that just one of these possible solutions has been reached based on the applied constraints. See also: [[#Flipping|Flipping]]. - - -There are two kinds of constraints: geometric and dimensional. They are detailed in the [[#Tools|Tools]] section below. - -=== Edit constraints === - - -When a [[Sketcher_ToggleDrivingConstraint|driving dimensional constraint]] is created, and if the {{MenuCommand|Ask for value after creating a dimensional constraint}} [[Sketcher_Preferences#Display|preference]] is selected (default), a dialog opens to edit its value. - - -[[Image:Sketcher_Edit_Constraint.png|Sketcher_Edit_Constraint.png]] - - - -You can enter a numerical value or an [[Expressions|expression]], and it is possible to name the constraint to facilitate its use in other expressions. You can also check the {{MenuCommand|Reference}} checkbox to switch the constrain to [[Sketcher_ToggleDrivingConstraint|reference mode]]. - - -To edit the value of an existing dimensional constraint do one of the following: -* Double-click the constraint value in the [[3D_View|3D View]]. -* Double-click the constraint in the [[Sketcher_Dialog|Sketcher Dialog]]. -* Right-click the constraint in the Sketcher Dialog and select the {{MenuCommand|Change value}} option from the context menu. - -=== Reposition constraints === - - -Dimensional constraints can be repositioned in the 3D View by dragging. Hold down the left mouse button over the constraint value and move the mouse. The symbols of geometric constraints are positioned automatically and cannot be moved. - -== Profile sketches == - - -To create a sketch that can be used as a profile for generating solids certain rules must be followed: -# The sketch must contain only closed contours. Gaps between endpoints, however small, are not allowed. -# Contours can be nested, to create voids, but should not self-intersect or intersect other contours. -# Contours cannot share edges with other contours. Duplicate or overlapping edges are not allowed. -# T-connections, that is more than two edges sharing a common point, or a point touching an edge, are not allowed. - - -[[File:Sketcher_profile_sketches_2.png|600px]] - - - -{{Caption|Invalid sketches:
-1. Open contour (free endpoints highlighted by the [[Sketcher_ValidateSketch|Validate Sketch tool]])
-2. Intersecting contours
-3. Duplicate edges (endpoints of overlapping edges highlighted by the [[Sketcher_ValidateSketch|Validate Sketch tool]])
-4. T-connections}} - - -These rules do not apply to construction geometry (default color blue), which is not shown outside edit mode, or if the sketch is used for a different purpose. Depending on the workbench and the tool that will use the profile sketch, additional restrictions may apply. - -== Tools == - - -The Sketcher Workbench tools are located in the Sketch menu and/or several toolbars. Almost all Sketcher toolbars are only displayed while a sketch is in edit mode. The only exception is the [[#Sketcher_toolbar|Sketcher toolbar]] which is only displayed if no sketch is in edit mode. - - -Some tools are also available from the [[3D_View|3D View]] context menu while a sketch is in edit mode, or from the context menus of the [[Sketcher_Dialog|Sketcher Dialog]]. - - -If a sketch is in edit mode the Structure toolbar is hidden as none of its tools can then be used. - -=== General === - -==== Sketcher toolbar ==== - - -* [[Image:Sketcher_NewSketch.svg|32px]] [[Sketcher_NewSketch|New Sketch]]: Creates a new sketch and opens the [[Sketcher_Dialog|Sketcher Dialog]] to edit it. - - -* [[Image:Sketcher_EditSketch.svg|32px]] [[Sketcher_EditSketch|Edit Sketch]]: Opens the Sketcher Dialog to edit an existing sketch. - - -* [[Image:Sketcher_MapSketch.svg|32px]] [[Sketcher_MapSketch|Attach Sketch]]: Attaches a sketch to selected geometry. - - -* [[File:Sketcher_ReorientSketch.svg|32px]] [[Sketcher_ReorientSketch|Reorient Sketch]]: Places a sketch on one of the main planes with an optional offset. It can also be used to detach a sketch. - - -* [[File:Sketcher_ValidateSketch.svg|32px]] [[Sketcher_ValidateSketch|Validate Sketch]]: Can analyze and repair a sketch that is no longer editable or has invalid constraints, or add missing coincident constraints. - - -* [[Image:Sketcher_MergeSketches.svg|32px]] [[Sketcher_MergeSketches|Merge Sketches]]: Merges two or more sketches. - - -* [[Image:Sketcher_MirrorSketch.svg|32px]] [[Sketcher_MirrorSketch|Mirror Sketch]]: Mirrors sketches across their X-axis, Y-axis, or origin. - -==== Edit Mode toolbar ==== - - -* [[Image:Sketcher_LeaveSketch.svg|32px]] [[Sketcher_LeaveSketch|Leave Sketch]]: Finishes sketch edit mode and closes the [[Sketcher_Dialog|Sketcher Dialog]]. - - -* [[Image:Sketcher_CancelSketch.svg|32px]] [[Sketcher_CancelSketch|Cancel Editing]]: Leaves sketch edit mode, reverts any changes, and closes the [[Sketcher_Dialog|Sketcher Dialog]]. {{Version|1.2}} - - -* [[Image:Sketcher_ViewSketch.svg|32px]] [[Sketcher_ViewSketch|Align View to Sketch]]: Aligns the [[3D_View|3D View]] with the sketch. - - -* [[Image:Sketcher_ViewSection.svg|32px]] [[Sketcher_ViewSection|Toggle Section View]]: Toggles a temporary section plane that hides any objects and parts of objects in front of the sketch plane. - -==== Other ==== - - -* [[File:Sketcher_StopOperation.svg|32px]] [[Sketcher_StopOperation|Stop Operation]]: Stops any currently running geometry or constraint creation tool. - - -* [[Sketcher_Grid|Grid]]: Grid settings can be changed in the menu of the [[Sketcher_Dialog#Sketch_Edit|Sketch Edit section of the Sketcher Dialog]]. - - -* [[Sketcher_Snap|Snap]]: Snap settings can be changed in the same menu. - - -* [[Sketcher_RenderingOrder|Rendering Order]]: The rendering order can be changed in the same menu. - -===Geometries=== - - -These are tools for creating objects. - - -* [[Image:Sketcher_CreatePoint.svg|32px]] [[Sketcher_CreatePoint|Point]]: Creates a point. - - -* [[Image:Sketcher_CreatePolyline.svg|32px]] [[Sketcher_CreatePolyline|Polyline]]: Creates a series of line and arc segments connected by their endpoints. The tool has several modes. - - -* [[Image:Sketcher_CreateLine.svg|32px]] [[Sketcher_CreateLine|Line]]: Creates a line. {{Version|1.0}}: The tool has three modes. - - -* [[Image:Sketcher_CreateArc.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Arc: - - -:* [[Image:Sketcher_CreateArc.svg|32px]] [[Sketcher_CreateArc|Arc From Center]]: Creates an arc from its center and its endpoints. {{Version|1.0}}: Or from its endpoints and a point along the arc. - - -:* [[Image:Sketcher_Create3PointArc.svg|32px]] [[Sketcher_Create3PointArc|Arc From 3 Points]]: Creates an arc from its endpoints and a point along the arc. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateArc|Arc From Center]] but with a different initial mode. - - -:* [[Image:Sketcher_CreateArcOfEllipse.svg|32px]] [[Sketcher_CreateArcOfEllipse|Elliptical Arc]]: Creates an elliptical arc. - - -:* [[Image:Sketcher_CreateArcOfHyperbola.svg|32px]] [[Sketcher_CreateArcOfHyperbola|Hyperbolic Arc]]: Creates an hyperbolic arc. - - -:* [[Image:Sketcher_CreateArcOfParabola.svg|32px]] [[Sketcher_CreateArcOfParabola|Parabolic Arc]]: Creates an parabolic arc. - - -* [[Image:Sketcher_CreateCircle.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Circle/Ellipse: - - -:* [[Image:Sketcher_CreateCircle.svg|32px]] [[Sketcher_CreateCircle|Circle From Center]]: Creates a circle from its center and a point along the circle. {{Version|1.0}}: Or from three points along the circle. - - -:* [[Image:Sketcher_Create3PointCircle.svg|32px]] [[Sketcher_Create3PointCircle|Circle From 3 Points]]: Creates a circle from three points along the circle. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateCircle|Circle From Center]] but with a different initial mode. - - -:* [[Image:Sketcher_CreateEllipseByCenter.svg|32px]] [[Sketcher_CreateEllipseByCenter|Ellipse From Center]]: Creates an ellipse from its center, an endpoint of one of its axes, and a point along the ellipse. {{Version|1.0}}: Or from both endpoints of one of its axes and a point along the ellipse. - - -:* [[Image:Sketcher_CreateEllipseBy3Points.svg|32px]] [[Sketcher_CreateEllipseBy3Points|Ellipse From 3 Points]]: Creates an ellipse from the endpoints of one of its axes and a point along the ellipse. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateEllipseByCenter|Ellipse From Center]] but with a different initial mode. - - -* [[Image:Sketcher_CreateRectangle.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Rectangle: - - -:* [[Image:Sketcher_CreateRectangle.svg|32px]] [[Sketcher_CreateRectangle|Rectangle]]: Creates a rectangle. {{Version|1.0}}: The tool has four modes. Rounded corners and creating an offset copy are optional features. - - -:* [[Image:Sketcher_CreateRectangle_Center.svg|32px]] [[Sketcher_CreateRectangle_Center|Centered Rectangle]]: Creates a centered rectangle. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateRectangle|Rectangle]] but with a different initial mode. - - -:* [[Image:Sketcher_CreateOblong.svg|32px]] [[Sketcher_CreateOblong|Rounded Rectangle]]: Creates a rounded rectangle. Idem. - - -* [[Image:Sketcher_CreateHexagon.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Polygon: - - -:* [[Image:Sketcher_CreateTriangle.svg|32px]] [[Sketcher_CreateTriangle|Triangle]]: creates an equilateral triangle. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateRegularPolygon|Polygon]] but with the number of sides preset to a specif value. - - -:* [[Image:Sketcher_CreateSquare.svg|32px]] [[Sketcher_CreateSquare|Square]]: Creates a square. Idem. - - -:* [[Image:Sketcher_CreatePentagon.svg|32px]] [[Sketcher_CreatePentagon|Pentagon]]: Creates a pentagon. Idem. - - -:* [[Image:Sketcher_CreateHexagon.svg|32px]] [[Sketcher_CreateHexagon|Hexagon]]: Creates a hexagon. Idem. - - -:* [[Image:Sketcher_CreateHeptagon.svg|32px]] [[Sketcher_CreateHeptagon|Heptagon]]: Creates a heptagon. Idem. - - -:* [[Image:Sketcher_CreateOctagon.svg|32px]] [[Sketcher_CreateOctagon|Octagon]]: Creates an octagon. Idem. - - -:* [[Image:Sketcher_CreateRegularPolygon.svg|32px]] [[Sketcher_CreateRegularPolygon|Polygon]]: Creates a regular polygon. The number of sides can be specified. - - -* [[Image:Sketcher_CreateSlot.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Slot: - - -:* [[Image:Sketcher_CreateSlot.svg|32px]] [[Sketcher_CreateSlot|Slot]]: Creates a slot. - - -:* [[Image:Sketcher_CreateArcSlot.svg|32px]] [[Sketcher_CreateArcSlot|Arc Slot]]: Creates an arc slot. {{Version|1.0}} - - -* [[Image:Sketcher_CreateBSpline.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create B-Spline: - - -:* [[File:Sketcher_CreateBSpline.svg|32px]] [[Sketcher_CreateBSpline|B-Spline]]: Creates a B-spline curve from control points. {{Version|1.0}}: Or from knot points. - - -:* [[File:Sketcher_CreatePeriodicBSpline.svg|32px]] [[Sketcher_CreatePeriodicBSpline|Periodic B-Spline]]: Creates a periodic (closed) B-spline curve from control points. {{Version|1.0}}: This is the same tool as [[Sketcher_CreateBSpline|B-Spline]] but with a different initial mode. - - -:* [[File:Sketcher_CreateBSplineByInterpolation.svg|32px]] [[Sketcher_CreateBSplineByInterpolation|B-Spline From Knots]]: Creates a B-spline curve from knot points. Idem. - - -:* [[File:Sketcher_CreatePeriodicBSplineByInterpolation.svg|32px]] [[Sketcher_CreatePeriodicBSplineByInterpolation|Periodic B-Spline From Knots]]: Creates a periodic (closed) B-spline curve from knot points. Idem. - - -* [[File:Sketcher_CreateText.svg|32px]] [[Sketcher_CreateText|Text]]: Creates text geometry controlled by a text constraint {{Version|1.2}}. - - -* [[File:Sketcher_ToggleConstruction.svg|32px]] [[Sketcher_ToggleConstruction|Toggle Construction Geometry]]: Either toggles the geometry creation tools to/from construction mode, or toggles selected geometry to/from construction geometry. - -===Constraints=== - - -These are tools for creating [[#Constraints|constraints]]. Some constraints require the use of [[Sketcher_helper_constraint|helper constraints]]. - - -* [[Image:Sketcher_Dimension.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Dimensional Constraints: - - -:* [[File:Sketcher_Dimension.svg|32px]] [[Sketcher_Dimension|Dimension]]: Is the context-sensitive constraint tool of the Sketcher Workbench. Based on the current selection, it offers appropriate dimensional constraints, but also geometric constraints. {{Version|1.0}} - - -:* [[File:Sketcher_ConstrainDistanceX.svg|32px]] [[Sketcher_ConstrainDistanceX|Horizontal Dimension]]: Fixes the horizontal distance between two points or the endpoints of a line. If a single point is pre-selected, the distance is relative to the origin of the sketch. - - -:* [[File:Sketcher_ConstrainDistanceY.svg|32px]] [[Sketcher_ConstrainDistanceY|Vertical Dimension]]: 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 origin of the sketch. - - -:* [[File:Sketcher_ConstrainDistance.svg|32px]] [[Sketcher_ConstrainDistance|Distance Dimension]]: Fixes the length of a line, the distance between two points, the perpendicular distance between a point and a line; or the distance between the edges of two circles or arcs, or between the edge of a circle or arc and a line; or, {{Version|1.0}}, the length of an arc. - - -:* [[File:Sketcher_ConstrainRadiam.svg|32px]] [[Sketcher_ConstrainRadiam|Radius/Diameter Dimension]]: Fixes the radius of arcs and B-spline weight circles, and the diameter of circles. - - -:* [[File:Sketcher_ConstrainRadius.svg|32px]] [[Sketcher_ConstrainRadius|Radius Dimension]]: Fixes the radius of circles, arcs and B-spline weight circles. - - -:* [[File:Sketcher_ConstrainDiameter.svg|32px]] [[Sketcher_ConstrainDiameter|Diameter Dimension]]: Fixes the diameter of circles and arcs. - - -:* [[File:Sketcher_ConstrainAngle.svg|32px]] [[Sketcher_ConstrainAngle|Angle Dimension]]: Fixes the angle between two edges, the angle of a line with the horizontal axis of the sketch, or the aperture angle of a circular arc. - - -:* [[File:Sketcher_ConstrainLock.svg|32px]] [[Sketcher_ConstrainLock|Lock Position]]: Applies [[Sketcher_ConstrainDistanceX|horizontal dimension]] and [[Sketcher_ConstrainDistanceY|vertical dimension]] constraints to points. If a single point is selected the constraints reference the origin of the sketch. If two or more points are selected the constraints reference the last point in the selection. - - -* [[File:Sketcher_ConstrainCoincidentUnified.svg|32px]] [[Sketcher_ConstrainCoincidentUnified|Coincident Constraint (Unified)]]: Creates a coincident constraint between points, fixes points on edges or axes, or creates a concentric constraint. It combines the [[Sketcher_ConstrainCoincident|Coincident Constraint]] and [[Sketcher_ConstrainPointOnObject|Point-On-Object Constraint]] tools. {{Version|1.0}} - - -* [[File:Sketcher_ConstrainCoincident.svg|32px]] [[Sketcher_ConstrainCoincident|Coincident Constraint]]: Creates a coincident constraint between points, or a concentric constraint. - - -* [[File:Sketcher_ConstrainPointOnObject.svg|32px]] [[Sketcher_ConstrainPointOnObject|Point-On-Object Constraint]]: Fixes points on edges or axes. - - -* [[Image:Sketcher_ConstrainHorVer.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]]Horizontal/Vertical Constraints: - - -:* [[File:Sketcher_ConstrainHorVer.svg|32px]] [[Sketcher_ConstrainHorVer|Horizontal/Vertical Constraint]]: Constrains lines or pairs of points to be horizontal or vertical, whichever is closest to the current alignment. It combines the [[Sketcher_ConstrainHorizontal|Horizontal Constrain]] and [[Sketcher_ConstrainVertical|Vertical Constrain]] tools. {{Version|1.0}} - - -:* [[File:Sketcher_ConstrainHorizontal.svg|32px]] [[Sketcher_ConstrainHorizontal|Horizontal Constraint]]: Constrains lines or pairs of points to be horizontal. - - -:* [[File:Sketcher_ConstrainVertical.svg|32px]] [[Sketcher_ConstrainVertical|Vertical Constraint]]: Constrains lines or pairs of points to be vertical. - - -* [[File:Sketcher_ConstrainParallel.svg|32px]] [[Sketcher_ConstrainParallel|Parallel Constraint]]: Constrains lines to be parallel. - - -* [[File:Sketcher_ConstrainPerpendicular.svg|32px]] [[Sketcher_ConstrainPerpendicular|Perpendicular Constraint]]: Constrains two lines to be perpendicular, or two edges, or an edge and an axis, to be perpendicular at their intersection. The constraint can also connect two edges, forcing them to be perpendicular at the joint. - - -* [[File:Sketcher_ConstrainTangent.svg|32px]] [[Sketcher_ConstrainTangent|Tangent/Collinear Constraint]]: Constrains two edges, or an edge and an axis, to be tangent. The constraint can also connect two edges, forcing them to be tangent at the joint. If two lines are selected they are made collinear. - - -* [[File:Sketcher_ConstrainEqual.svg|32px]] [[Sketcher_ConstrainEqual|Equal Constraint]]: Constrains edges to have an equal length (lines) or curvature (other edges except B-splines). - - -* [[File:Sketcher_ConstrainSymmetric.svg|32px]] [[Sketcher_ConstrainSymmetric|Symmetric Constraint]]: Constrains two points to be symmetrical around a line or axis, or around a third point. - - -* [[Image:Sketcher_ConstrainBlock.svg|32px]] [[Sketcher_ConstrainBlock|Block Constraint]]: Blocks edges in place with a single constraint. It is mainly intended for B-splines. - - -* [[Image:Sketcher_ConstrainGroup.svg|32px]] [[Sketcher_ConstrainGroup|Group Constraint]]: Groups selected geometry. {{Version|1.2}} - - -* [[File:Sketcher_ConstrainSnellsLaw.svg|32px]] [[Sketcher_ConstrainSnellsLaw|Refraction Constraint]]: Constrains two lines to follow the law of refraction of light as it penetrates through an interface. +==Introduction== - -* [[Image:Sketcher_ToggleDrivingConstraint.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Toggle Constraints: +The [[Image:Workbench_Sketcher.svg|24px]] '''Sketcher Workbench''' is used to create 2D geometries called sketches. These sketches form the basis of 3D geometry created with the [[PartDesign_Workbench|PartDesign Workbench]]. - -:* [[File:Sketcher_ToggleDrivingConstraint.svg|32px]] [[Sketcher_ToggleDrivingConstraint|Toggle Driving/Reference Constraints]]: Toggles the dimensional constraint creation tools between driving and reference mode, or toggles selected dimensional constraints between those modes. +Sketches are the foundation for creating parametric models in FreeCAD. They define the 2D profiles that can be extruded, revolved, or used in other 3D modeling operations. - -:* [[File:Sketcher_ToggleActiveConstraint.svg|32px]] [[Sketcher_ToggleActiveConstraint|Toggle Constraints]]: Activates or deactivates selected constraints. +==Workflow=== -===Sketcher Tools=== +A typical workflow with the Sketcher Workbench is: - -* [[Image:Sketcher_CreateFillet.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Create Fillet/Chamfer: +# Create a new sketch on a plane or face. +# Draw geometry using the sketching tools. +# Apply constraints to define the exact shape and dimensions. +# Close the sketch. +# Use the sketch in a [[PartDesign_Workbench|PartDesign]] feature (pad, pocket, revolution, etc.). - -:* [[Image:Sketcher_CreateFillet.svg|32px]] [[Sketcher_CreateFillet|Fillet]]: Creates a fillet between two non-parallel edges. {{Version|1.0}}: The tool can also create a chamfer. +==Tools=== - -:* [[Image:Sketcher_CreateChamfer.svg|32px]] [[Sketcher_CreateChamfer|Chamfer]]: creates a chamfer between two non-parallel edges. This is the same tool as [[Sketcher_CreateFillet|Fillet]] but with a different initial mode. {{Version|1.0}} +The Sketcher tools are organized into the following categories: - -* [[Image:Sketcher_Trimming.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Edit Edge: +===General=== - -:* [[Image:Sketcher_Trimming.svg|32px]] [[Sketcher_Trimming|Trim Edge]]: Trims an edge at the nearest intersections with other edges. +* [[Image:Sketcher_CreateSketch.svg|24px]] [[Sketcher_CreateSketch|Create Sketch]]: Create a new sketch on a selected plane or face. +* [[Image:Sketcher_LeaveSketch.svg|24px]] [[Sketcher_LeaveSketch|Leave Sketch]]: Leave the sketch editing mode. - -:* [[Image:Sketcher_Split.svg|32px]] [[Sketcher_Split|Split Edge]]: Splits an edge while transferring most constraints. +===Geometry Tools=== - -:* [[File:Sketcher_Extend.svg|32px]] [[Sketcher_Extend|Extend Edge]]: Extends or shortens a line or an arc to an arbitrary location, or to a target edge or point. +* [[Image:Sketcher_CreatePoint.svg|24px]] [[Sketcher_CreatePoint|Create Point]] +* [[Image:Sketcher_CreateLine.svg|24px]] [[Sketcher_CreateLine|Create Line]] +* [[Image:Sketcher_CreatePolyline.svg|24px]] [[Sketcher_CreatePolyline|Create Polyline]] +* [[Image:Sketcher_CreateArc.svg|24px]] [[Sketcher_CreateArc|Create Arc]] - -* [[Image:Sketcher_Projection.svg|32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] External Geometry: +===Constraint Tools=== - -:* [[Image:Sketcher_Projection.svg|32px]] [[Sketcher_Projection|External Projection]]: Creates the projection edges of external geometry. {{Version|1.1}} +* [[Image:Sketcher_ConstrainDistanceX.svg|24px]] [[Sketcher_ConstrainDistanceX|Constrain Horizontal Distance]] +* [[Image:Sketcher_ConstrainDistanceY.svg|24px]] [[Sketcher_ConstrainDistanceY|Constrain Vertical Distance]] - -:* [[Image:Sketcher_Intersection.svg|32px]] [[Sketcher_Intersection|External Intersection]]: Creates the intersection edges of external geometry with the sketch plane. {{Version|1.1}} - - -* [[File:Sketcher_CarbonCopy.svg|32px]] [[Sketcher_CarbonCopy|Carbon Copy]]: Copies all geometry and constraints from another sketch into the active sketch. - - -* [[File:Sketcher_SelectOrigin.svg|32px]] [[Sketcher_SelectOrigin|Select Origin]]: Selects the origin of the sketch. - - -* [[File:Sketcher_SelectHorizontalAxis.svg|32px]] [[Sketcher_SelectHorizontalAxis|Select Horizontal Axis]]: Selects the horizontal axis of the sketch. - - -* [[File:Sketcher_SelectVerticalAxis.svg|32px]] [[Sketcher_SelectVerticalAxis|Select Vertical Axis]]: Selects the vertical axis of the sketch. - - -* [[File:Sketcher_Translate.svg|32px]] [[Sketcher_Translate|Move/Array Transform]]: Moves or optionally creates copies of selected elements. {{Version|1.0}} - - -* [[File:Sketcher_Rotate.svg|32px]] [[Sketcher_Rotate|Rotate/Polar Transform]]: Rotates or optionally creates rotated copies of selected elements. {{Version|1.0}} - - -* [[File:Sketcher_Scale.svg|32px]] [[Sketcher_Scale|Scale]]: Scales or optionally creates scaled copies of selected elements. {{Version|1.0}} - - -* [[File:Sketcher_Offset.svg|32px]] [[Sketcher_Offset|Offset]]: Creates equidistant edges around selected edges. {{Version|1.0}} - - -* [[File:Sketcher_Symmetry.svg|32px]] [[Sketcher_Symmetry|Mirror]]: Creates mirrored copies of selected elements. - - -* [[File:Sketcher_RemoveAxesAlignment.svg|32px]] [[Sketcher_RemoveAxesAlignment|Remove Axes Alignment]]: Removes the axes alignment of selected edges by replacing [[Sketcher_ConstrainHorizontal|horizontal]] and [[Sketcher_ConstrainVertical|vertical]] constraints with [[Sketcher_ConstrainParallel|parallel]] and [[Sketcher_ConstrainPerpendicular|perpendicular]] constraints. - - -* [[File:Sketcher_DeleteAllGeometry.svg|32px]] [[Sketcher_DeleteAllGeometry|Delete All Geometry]]: Deletes all geometry and all constraints from the sketch. - - -* [[File:Sketcher_DeleteAllConstraints.svg|32px]] [[Sketcher_DeleteAllConstraints|Delete All Constraints]]: Deletes all constraints from the sketch. - - -* [[File:Edit-copy.svg|32px]] Copy Elements: See [[#Copy,_cut_and_paste|Copy, cut and paste]]. - - -* [[File:Edit-cut.svg|32px]] Cut Elements: See [[#Copy,_cut_and_paste|Copy, cut and paste]]. - - -* [[File:Edit-paste.svg|32px]] Paste Elements: See [[#Copy,_cut_and_paste|Copy, cut and paste]]. - -===B-Spline Tools=== - - -* [[File:Sketcher_BSplineConvertToNURBS.svg|32px]] [[Sketcher_BSplineConvertToNURBS|Geometry to B-Spline]]: Converts edges to B-splines. - - -* [[File:Sketcher_BSplineIncreaseDegree.svg|32px]] [[Sketcher_BSplineIncreaseDegree|Increase B-Spline Degree]]: Increases the degree (order) of B-splines. - - -* [[File:Sketcher_BSplineDecreaseDegree.svg|32px]] [[Sketcher_BSplineDecreaseDegree|Decrease B-Spline Degree]]: Decreases the degree (order) of B-splines. - - -* [[File:Sketcher_BSplineIncreaseKnotMultiplicity.svg|32px]] [[Sketcher_BSplineIncreaseKnotMultiplicity|Increase Knot Multiplicity]]: Increases the multiplicity of a B-spline knot. - - -* [[File:Sketcher_BSplineDecreaseKnotMultiplicity.svg|32px]] [[Sketcher_BSplineDecreaseKnotMultiplicity|Decrease Knot Multiplicity]]: Decreases the multiplicity of a B-spline knot. - - -* [[File:Sketcher_BSplineInsertKnot.svg|32px]] [[Sketcher_BSplineInsertKnot|Insert Knot]]: Inserts a knot into a B-spline or increases the multiplicity of an existing knot. - - -* [[File:Sketcher_JoinCurves.svg|32px]] [[Sketcher_JoinCurves|Join Curves]]: Creates a B-spline by joining two existing B-splines or other edges. - -===Visual Helpers=== - - -* [[File:Sketcher_SelectElementsWithDoFs.svg|32px]] [[Sketcher_SelectElementsWithDoFs|Select Under-Constrained Elements]]: Selects the not fully constrained elements in the sketch. - - -* [[File:Sketcher_SelectConstraints.svg|32px]] [[Sketcher_SelectConstraints|Select Associated Constraints]]: Selects the constraints associated with sketch elements. - - -* [[File:Sketcher_SelectElementsAssociatedWithConstraints.svg|32px]] [[Sketcher_SelectElementsAssociatedWithConstraints|Select Associated Geometry]]: Selects the sketch elements associated with constraints. - - -* [[File:Sketcher_SelectRedundantConstraints.svg|32px]] [[Sketcher_SelectRedundantConstraints|Select Redundant Constraints]]: Selects the redundant constraints in the sketch. - - -* [[File:Sketcher_SelectConflictingConstraints.svg|32px]] [[Sketcher_SelectConflictingConstraints|Select Conflicting Constraints]]: Selects the conflicting constraints in the sketch. - - -* [[File:Sketcher_ArcOverlay.svg|32px]] [[Sketcher_ArcOverlay|Toggle Circular Helper for Arcs]]: Shows or hides the circular helpers (underlying virtual circles) for arcs in all sketches. {{Version|1.0}} - - -* [[Image:Sketcher_BSplinePolygon.svg|x32px]][[Image:Toolbar_flyout_arrow_blue_background.svg|x32px]] Toggle B-Spline Information Layer: - - -:* [[File:Sketcher_BSplineDegree.svg|32px]] [[Sketcher_BSplineDegree|Toggle B-Spline Degree]]: Shows or hides the B-spline degree in all sketches. - - -:* [[File:Sketcher_BSplinePolygon.svg|32px]] [[Sketcher_BSplinePolygon|Toggle B-Spline Control Polygon]]: Shows or hides the B-spline control polygon in all sketches. - - -:* [[File:Sketcher_BSplineComb.svg|32px]] [[Sketcher_BSplineComb|Toggle B-Spline Curvature Comb]]: Shows or hides the B-spline curvature comb in all sketches. - - -:* [[File:Sketcher_BSplineKnotMultiplicity.svg|32px]] [[Sketcher_BSplineKnotMultiplicity|Toggle B-Spline Knot Multiplicity]]: Shows or hides the B-spline knot multiplicity in all sketches. - - -:* [[File:Sketcher_BSplinePoleWeight.svg|32px]] [[Sketcher_BSplinePoleWeight|Toggle B-Spline Control Point Weight]]: Shows or hides the B-spline control point weight in all sketches. - - -* [[File:Sketcher_RestoreInternalAlignmentGeometry.svg|32px]] [[Sketcher_RestoreInternalAlignmentGeometry|Toggle Internal Geometry]]: Deletes the internal geometry of elements, or recreates missing internal geometry. - - -* [[File:Sketcher_SwitchVirtualSpace.svg|32px]] [[Sketcher_SwitchVirtualSpace|Switch Virtual Space]]: (un)hides constraints or switches the visible virtual space. - -===Obsolete tools=== - - -* [[File:Sketcher_Clone.svg|32px]] [[Sketcher_Clone|Clone]]: Clones a Sketcher element. Not available in {{VersionPlus|1.0}}. - - -* [[File:Sketcher_CloseShape.svg|32px]] [[Sketcher_CloseShape|Close shape]]: Creates a closed shape by applying coincident constraints to endpoints. Not available in {{VersionPlus|0.21}}. - - -* [[File:Sketcher_CreatePointFillet.svg|32px]] [[Sketcher_CreatePointFillet|Corner-preserving fillet]]: Creates a fillet between two non-parallel lines while preserving their corner point. Not available in {{VersionPlus|1.0}}. - - -* [[File:Sketcher_ConnectLines.svg|32px]] [[Sketcher_ConnectLines|Connect edges]]: Connect Sketcher elements by applying coincident constraints to endpoints. Not available in {{VersionPlus|0.21}}. - - -* [[File:Sketcher_Copy.svg|32px]] [[Sketcher_Copy|Copy]]: Copies a Sketcher element. Not available in {{VersionPlus|1.0}}. - - -* [[Image:Sketcher_External.svg|32px]] [[Sketcher_External|External geometry]]: Projects edges and/or vertices belonging to objects outside the sketch onto the sketch plane. Not available in {{VersionPlus|1.1}}. - - -* [[File:Sketcher_Move.svg|32px]] [[Sketcher_Move|Move]]: Moves the selected geometry taking as reference the last selected point. Not available in {{VersionPlus|1.0}}. - - -* [[File:Sketcher_RectangularArray.svg|32px]] [[Sketcher_RectangularArray|Rectangular array]]: Creates an array of selected Sketcher elements. Not available in {{VersionPlus|1.0}}. - -== Preferences == - - -* [[Image:Workbench_Sketcher.svg|32px]] [[Sketcher_Preferences|Preferences]]: Preferences for the Sketcher Workbench. - -== Drawing aids == - - -The Sketcher Workbench has several drawing aids and other features that can help when creating geometry and applying constraints. - -=== Continue modes === - - -There are two continue modes: '''Geometry creation "Continue Mode"''' and '''Constraint creation "Continue Mode"'''. If these are checked (default) in the [[Sketcher_Preferences#Display|preferences]], related tools will restart after finishing. To exit a continuous tool press {{KEY|Esc}} or the right mouse button. This must be repeated if a continuous geometry tool has already received input. You can also exit a continuous tool by starting another geometry or constraint creation tool. Note that pressing {{KEY|Esc}} if no tool is active will exit sketch edit mode. Uncheck the '''Esc key can leave sketch edit mode''' [[Sketcher_Preferences#General|preference]] if you often inadvertently press {{KEY|Esc}} too many times. - -=== Auto constraints === - - -In sketches that have '''Auto constraints''' checked (default) several constraints are applied automatically. The icon of a proposed automatic constraint is shown next to the cursor when it is placed correctly. Left-clicking will then apply that constraint. This is a per-sketch setting that can be changed in the [[Sketcher_Dialog#Constraints|Sketcher Dialog]] or by changing the {{PropertyView|Autoconstraints}} [[Property_View|property]] of the sketch. - - -The following constraints are applied automatically: -* [[Image:Sketcher_ConstrainCoincident.svg|16px]] [[Sketcher_ConstrainCoincident|Coincident]] -* [[Image:Sketcher_ConstrainPointOnObject.svg|16px]] [[Sketcher_ConstrainPointOnObject|Point-on-object]] -* [[Image:Sketcher_ConstrainHorizontal.svg|16px]] [[Sketcher_ConstrainHorizontal|Horizontal]] -* [[Image:Sketcher_ConstrainVertical.svg|16px]] [[Sketcher_ConstrainVertical|Vertical]] -* [[Image:Sketcher_ConstrainTangent.svg|16px]] [[Sketcher_ConstrainTangent|Tangent]] -* {{Version|1.0}}: [[Image:Sketcher_ConstrainSymmetric.svg|16px]] [[Sketcher_ConstrainSymmetric|Symmetric]] (line midpoint) - -=== Snapping === - - -{{Version|0.21}} - - -It is possible to [[Sketcher_Grid|snap to grid lines and grid intersection]], and to [[Sketcher_Snap|snap to edges of geometry and midpoints of lines and arcs, and to certain angles]]. Please note that snapping does not produce constraints in and of itself. For example, only if [[#Auto_constraints|Auto constraints]] is switched on will snapping to an edge produce a [[Sketcher_ConstrainPointOnObject|point-on-object constraint]]. But just picking a point on the edge would then have the same result. - -=== On-View-Parameters === - - -{{Version|1.0}} - - -Depending on the selected option in the [[Sketcher_Preferences#General|preferences]] only the dimensional On-View-Parameters or both the dimensional and the positional On-View-Parameters can be enabled. Positional parameters allow the input of exact coordinates, for example the center of a circle, or the start point of a line. Dimensional parameters allow the input of exact dimensions, for example the radius of a circle, or the length and angle of a line. On-View-Parameters are not available for all tools. - - -[[Image:Sketcher_On_view_parameters_positional.png]] - - -{{Caption|Determining the center point of a circle with the positional parameters enabled}} - - -[[Image:Sketcher_On_view_parameters_dimensional.png]] - - -{{Caption|Determining the radius of a circle with the dimensional parameters enabled}} - - -If values are entered and confirmed by pressing {{KEY|Enter}} or {{KEY|Tab}}, related constraints are added automatically. If two parameters are displayed at the same time, for example the X- and Y-coordinate of a point, it is possible to enter one value and pick a point to define the other. Depending on the object additional constraints may be required to fully constrain it. Constraints resulting from On-View-Parameters take precedence over those that may result from [[Sketcher_Dialog#Constraints|Auto constraints]]. - - -[[Image:Sketcher_ArcExample3.png|300px]] - - -{{Caption|Arc created by entering all On-View-Parameters with resulting automatically created constraints}} - -=== Coordinate display === - - -If the '''Show coordinates next to the cursor while editing''' [[Sketcher_Preferences#Display|preference]] is checked (default), the parameters of the current geometry tool (coordinates, radius, or length and angle) are displayed next to the cursor. This is deactivated while On-View-Parameters are shown. - -== Selection methods == - - -While a sketch is in edit mode the following selection methods can be used: - -=== 3D View element selection === - - -As elsewhere in FreeCAD, an element can be selected in the [[3D_View|3D View]] with a single left mouse click. But there is no need to hold down the {{KEY|Ctrl}} key when selecting multiple elements. Holding down that key is possible though and has the advantage that you can miss-click without losing the selection. Edges, points and constraints can be selected in this manner. - -=== 3D View box selection === - - -Box selection in the 3D View works without using [[Std_BoxSelection|Std BoxSelection]] or [[Std_BoxElementSelection|Std BoxElementSelection]]: -# Make sure that no tool is active. -# Do one of the following: -#* Click in an empty area and drag a rectangle from left to right to select elements that lie completely inside the rectangle. -#* Click in an empty area and drag a rectangle from right to left to also select elements that touch or cross the rectangle. - - -You can box-select edges and points, constraints cannot be box-selected. {{Version|1.2}}: [[Part_SelectFilter|Selection filters]] are taken into account. - -=== 3D View connected geometry selection === - - -{{Version|1.0}} - - -Double-clicking an edge in the 3D View will select all edges directly and indirectly connected with that edge via endpoints. There is no need for the edges to be connected with [[Sketcher_ConstrainCoincident|coincident constraints]], endpoints need only have the same coordinates. - -=== Sketcher Dialog selection === - - -Edges and points can also be selected from the Elements section of the [[Sketcher_Dialog|Sketcher Dialog]], and constraints from the Constraints section of that dialog. - -=== Select All shortcut === - - -{{Version|1.1}} - - -To select everything within a sketch, use the standard keyboard shortcut {{KEY|Ctrl}}+{{KEY|A}} or the {{MenuCommand|Edit → Select All}} option from the menu. - -== Copy, cut and paste == - - -{{Version|1.0}} - - -The standard keyboard shortcuts, {{KEY|Ctrl}}+{{KEY|C}}, {{KEY|Ctrl}}+{{KEY|X}} and {{KEY|Ctrl}}+{{KEY|V}}, can be used to copy, cut and paste selected Sketcher geometry including related constraints. But these tools are also available from the {{MenuCommand|Sketch → Sketcher Tools}} menu. They can be used within the same sketch but also between different sketches or separate instances of FreeCAD. Since the data is copied to the clipboard in the form of Python code, it can be used in other ways too (e.g. shared on the forum). - -== Best practices == - - -Every CAD user develops their own way of working over time, but there are some useful general principles to follow. - - -* A series of simple sketches is easier to manage than a single complex one. For example, a first sketch can be created for the base 3D feature (a pad or a revolve for example), while a second one can contain holes or cutouts (pockets). Some details can be left out, to be realized later on as 3D features. You can choose to avoid fillets in your sketch if there are too many, and add them as a 3D feature. -* Always create a closed profile, or your sketch won't produce a solid, but rather a set of open faces. If you don't want some of the objects to be included in the solid creation, turn them to construction elements with the [[Sketcher_ToggleConstruction|Toggle Construction Geometry]] tool. -* Use the Auto constraints feature to limit the number of constraints you'll have to add manually. -* As a general rule, apply geometric constraints first, then dimensional constraints, and lock your sketch last. But remember: rules are made to be broken. If you're having trouble manipulating your sketch, it may be useful to constrain a few objects first before completing your profile. -* If possible, center your sketch at the origin (0,0). If your sketch is not symmetric, locate one of its points at the origin. -* If you have the possibility to choose between the distance dimension and the horizontal or vertical dimensions, prefer the latter. Horizontal and vertical dimensions are computationally cheaper. -* In general, the best constraints to use are: horizontal and vertical constraints; horizontal and vertical dimensions; point-to-point tangent constraints. If possible, limit the use of these: distance dimension; edge-to-edge tangent constraint; point-on-object constraint; symmetric constraint. -* If in doubt about the validity of a sketch once it is complete (features turn green), close the Sketcher Dialog and use [[File:Sketcher_ValidateSketch.svg|24px]] [[Sketcher_ValidateSketch|Validate Sketch]]. - -== Flipping == - - -The phenomenon that a fully constrained sketch, usually after a major change to one of its dimensions, reaches an unintended new state is know as "flipping". In the example below, changing one dimension completely changes the shape of the sketch. Note that the sketch with the new shape is still fully constrained. - - -[[File:Sketcher_Flipping_Equal_Constraints.png|300px]] [[File:Sketcher_Flipping_Equal_Constraints_Flipped.png|300px]] - - -{{Caption|Original sketch (left), and the same sketch after increasing the 20mm value to 1000mm (right)}} - -=== Methods to reduce flipping === - -==== Change dimensions in small increments ==== - - -This is not always practical, but changing dimension values in smaller increments can work. - -==== Use a different solver ==== - - -The LevenbergMarquardt solver, which is not the default solver, is known to be less prone to flipping. See [[Sketcher_Dialog#Advanced_solver_control|Sketcher Dialog]] for more information. - -==== Use horizontal and vertical dimensions ==== - - -[[File:Sketcher_Flipping_HorVer_Dimensions.png|300px]] - - - -Using [[Sketcher_ConstrainDistanceX|horizontal]] and [[Sketcher_ConstrainDistanceY|vertical dimensions]] instead of [[Sketcher_ConstrainDistance|distance dimensions]] or [[Sketcher_ConstrainEqual|equal constraints]] can prevent flipping. Points constrained by these dimensions will only switch places if the sign of their value is changed. In the image above the added (orange) dimensional constraints are linked to the original dimensions via [[Expressions|expressions]]. - -==== Use angle dimensions ==== - - -[[File:Sketcher_Flipping_Angular_Dimensions.png|300px]] - - - -Using [[Sketcher_ConstrainAngle|angle dimensions]] instead of [[Sketcher_ConstrainHorizontal|horizontal]] and [[Sketcher_ConstrainVertical|vertical]] constraints can also work. The angle between edges constrained by angle dimensions will not change. 180° will not become 0°, 90° will not become 270°, etc. In the image all horizontal and vertical constraints have been replaced, but just replacing two is already effective here. - -== Tutorials == - - -* [https://forum.freecad.org/viewtopic.php?f=36&t=30104 Sketcher Lecture] by chrisb. This is a more than 80 page PDF document that serves as a detailed manual for the Sketcher. It explains the basics of Sketcher usage, and goes into a lot of detail about the creation of geometrical shapes, and each of the constraints. -* [[Basic_Sketcher_Tutorial|Basic Sketcher Tutorial]] for beginners -* [[Sketcher_Micro_Tutorial_-_Constraint_Practices|Sketcher Micro Tutorial - Constraint Practices]] -* [[Sketcher_requirement_for_a_sketch|Sketcher requirement for a sketch]] Minimum requirement for a sketch and Complete determination of a sketch - -== Scripting == - - -The [[Sketcher_scripting|Sketcher scripting]] page contains examples on how to create constraints from Python scripts. - -== Examples == - - -For some ideas of what can be achieved with Sketcher tools, have a look at: [[Sketcher_Examples|Sketcher Examples]]. - - -[[Image:Sketcher_ExampleHinge-01.gif|80px|link=]] -[[Image:Sketcher ExampleHinge-15.png|90px|link=]] - - - - {{Docnav -|[[Robot_Workbench|Robot Workbench]] -|[[Spreadsheet_Workbench|Spreadsheet Workbench]] -|IconL=Workbench_Robot.svg -|IconR=Workbench_Spreadsheet.svg +| +|[[Sketcher_CreatePoint|Create Point]] +|[[Sketcher_Workbench|Sketcher]] +|IconL= +|IconC=Workbench_Sketcher.svg +|IconR=Sketcher_CreatePoint.svg }} - -{{Sketcher_Tools_navi{{#translation:}}}} -{{Userdocnavi{{#translation:}}}} -[[Category:Workbenches{{#translation:}}]] \ No newline at end of file +{{Sketcher Tools navi}} + +{{Userdocnavi}}