TechDraw Preferences: Difference between revisions

From FreeCAD Documentation
m (add interlink)
No edit summary
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Page in progress{{#translation:}}}}
<languages/>
<languages/>
<translate>
<translate>
Line 21: Line 20:
The preferences of the [[TechDraw Workbench|TechDraw Workbench]] are found in the [[Preferences Editor|Preferences Editor]], {{MenuCommand|Edit → Preferences → TechDraw}}.
The preferences of the [[TechDraw Workbench|TechDraw Workbench]] are found in the [[Preferences Editor|Preferences Editor]], {{MenuCommand|Edit → Preferences → TechDraw}}.


<!--T:57-->
All preferences settings with ''italic'' labels are default values for new drawing objects. They have no effect on existing objects.
All preferences settings with ''italic'' labels are default values for new drawing objects. They have no effect on existing objects.


Line 26: Line 26:


<!--T:20-->
<!--T:20-->
[[Image:TechDraw_Preferences1.png|thumb|250px]]
[[Image:TechDraw_PreferencesGeneral.png|thumb|350px|General preferences]]


===Drawing Update=== <!--T:12-->
===Drawing Update=== <!--T:12-->
Line 33: Line 33:
{{Version|0.19}}
{{Version|0.19}}
* '''Update With 3D''': Whether or not pages are updated every time the 3D model is changed. This is a global policy setting.
* '''Update With 3D''': Whether or not pages are updated every time the 3D model is changed. This is a global policy setting.
* '''Allow Page Override''': Whether or not a page's ''Keep Update'' property can override the global '''Update With 3D''' parameter. This is a global policy setting.
* '''Allow Page Override''': Whether or not a page's '''[[TechDraw_PageDefault#Properties|Keep Update]]''' property can override the global '''Update With 3D''' parameter. This is a global policy setting.
* '''Keep Page Up To Date''': Keeps the drawing pages in sync with the 3D model in real time. This can slow the response time.
* '''Keep Page Up To Date''': Keeps drawing pages in sync with changes of the 3D model ''in real time''. This can slow down the response time.
* '''Auto-distribute Secondary Views''': Automatically distributes secondary views for [[Image:TechDraw_ProjectionGroup.svg|16px]] [[TechDraw_ProjectionGroup|Projection Groups]].
* '''Auto-distribute Secondary Views''': Automatically distributes secondary views for [[TechDraw_ProjectionGroup|projection groups]].

===Colors=== <!--T:8-->

<!--T:13-->
Setup of the default colors for new pages. Additionally there is an option:

<!--T:36-->
* '''Transparent Faces''': If checked, object faces will be transparent. {{Version|0.19}}


===Labels=== <!--T:14-->
===Labels=== <!--T:14-->
Line 54: Line 46:


<!--T:16-->
<!--T:16-->
* '''Default Template''': Default [[TechDraw_Templates|Template]] file for new pages.
* '''Default Template''': Default [[TechDraw_Templates|template]] file for new pages.
* '''Template Directory''': Starting directory for {{Button|[[Image:TechDraw_PageTemplate.svg|16px]] [[TechDraw_PageTemplate|Insert Page using Template]]}}.
* '''Template Directory''': Starting directory for toolbar button {{Button|[[Image:TechDraw_PageTemplate.svg|16px]] [[TechDraw_PageTemplate|Insert Page using Template]]}}.
* '''SVG Hatch Pattern''': Default [[SVG|SVG]] or [[bitmap|bitmap]] file for {{Button|[[Image:TechDraw_Hatch.svg|16px]] [[TechDraw_Hatch|Hatch Face using Image File]]}}.
* '''Hatch Pattern File''': Default [[SVG|SVG]] or [[bitmap|bitmap]] file for [[TechDraw_Hatch|hatches]].
* '''Line Group File''': Alternate file for personal [[TechDraw_LineGroup|Line Group]] definitions.
* '''Line Group File''': Alternate file for personal [[TechDraw_LineGroup|line group]] definitions.
* '''Welding Directory''': Default directory for {{Button|[[File:TechDraw_WeldSymbol.svg|16px]] [[TechDraw_WeldSymbol|Add Welding Information to Leader]]}}. {{Version|0.19}}
* '''Welding Directory''': Default directory for toolbar button {{Button|[[File:TechDraw_WeldSymbol.svg|16px]] [[TechDraw_WeldSymbol|Add Welding Information to Leader]]}}. {{Version|0.19}}
* '''PAT File''': Default PAT pattern definition file for {{Button|[[Image:TechDraw_GeometricHatch.svg|16px]] [[TechDraw_GeometricHatch|Apply Geometric Hatch to Face]]}}.
* '''PAT File''': Default PAT pattern definition file for [[TechDraw_GeometricHatch|geometric hatches]].
* '''Pattern Name''': Name of the default PAT pattern.
* '''Pattern Name''': Name of the default PAT pattern.


Line 65: Line 57:


<!--T:39-->
<!--T:39-->
[[Image:TechDraw_Preferences2.png|thumb|350px]]
[[Image:TechDraw_PreferencesScale.png|thumb|350px|Scale preferences]]


===Scale=== <!--T:40-->
===Scale=== <!--T:40-->
Line 77: Line 69:


<!--T:43-->
<!--T:43-->
* '''Edge Fuzz''': Size of selection area around edges. ??unit??
* '''Edge Fuzz''': Size of selection area around edges. The fuzz unit is approximately 0.1 mm, depending on your current zoom.
* '''Mark Fuzz''': Selection area around center marks. ??unit??
* '''Mark Fuzz''': Selection area around center marks. The fuzz unit is approximately 0.1 mm, depending on your current zoom.
* '''Overlap Radius''': Area to be inspected for overlap object selection. ''(not implemented yet)''


===Size Adjustments=== <!--T:44-->
===Size Adjustments=== <!--T:44-->
Line 86: Line 77:
* '''Vertex Scale''': Scale of [[Glossary#V|vertex]] dots. Multiplier of line width.
* '''Vertex Scale''': Scale of [[Glossary#V|vertex]] dots. Multiplier of line width.
* '''Center Mark Scale''': Size of center marks. Multiplier of vertex size.
* '''Center Mark Scale''': Size of center marks. Multiplier of vertex size.
* '''Tolerance Text Scale''': Tolerance font size adjustment. Multiplier of [[TechDraw_Preferences#Dimensions_2|dimension '''Font Size''']].
* '''Tolerance Text Scale''': Tolerance font size adjustment. Multiplier of dimension '''[[TechDraw_Preferences#Dimensions_2|Font Size]]'''.
* '''Template Edit Mark''': Size of [[TechDraw_Templates|template]] field click handles in mm (green dots).
* '''Template Edit Mark''': Size of [[TechDraw_Templates|template]] field click handles in mm (green dots).
* '''Welding Symbol Scale''': Multiplier for size of [[TechDraw_WeldSymbol|welding symbols]]. {{Version|0.19}}


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


<!--T:22-->
<!--T:22-->
[[Image:TechDraw_Preferences3.png|thumb|350px]]
[[Image:TechDraw_PreferencesDimensions.png|thumb|350px|Dimensions preferences]]


===Dimensions=== <!--T:10-->
===Dimensions=== <!--T:10-->


<!--T:17-->
<!--T:17-->
* '''Standard and Style''': The standard to be used for dimensional values. The options are
* '''Standard and Style''': The standard to be used for dimensional values. The difference between the standards are shown in the image: [[File:TechDraw_Dimension_standardization.png|thumb|center||500px|Differences between the supported standards]]
** '''ISO oriented''': ??
** '''ISO Referencing''': ??
** '''ASME Inlined''': ??
** '''ASME Referencing''': ??
* '''Use Global Decimals''': Use number of decimals from the [[Preferences_Editor#Units|general preferences]].
* '''Use Global Decimals''': Use number of decimals from the [[Preferences_Editor#Units|general preferences]].
* '''Show Units''': Appends the unit (mm, in, etc.) to dimension values.
* '''Show Units''': Appends the unit (mm, in, etc.) to dimension values.
Line 111: Line 99:
* '''Arrow Size''': Arrowhead size of dimensions.
* '''Arrow Size''': Arrowhead size of dimensions.


===Annotation=== <!--T:11-->
===Conventions=== <!--T:46-->

<!--T:47-->
* '''Projection Group Angle''': If [[TechDraw_ProjectionGroup|projection groups]] will use either first- or third-angle projection. See [https://en.wikipedia.org/wiki/Multiview_projection#Multiviews multiview projection] for an explanation.
* '''Hidden Line Style''': The style to be used for hidden lines.

==Annotation== <!--T:11-->

<!--T:61-->
[[Image:TechDraw_PreferencesAnnotation.png|thumb|350px|Annotation preferences]]


<!--T:18-->
<!--T:18-->
* '''Section Line Standard''': Standard to be used to draw section lines in [[TechDraw_NewSection| section views]].
* '''Section Line Standard''': Standard to be used to draw section lines in [[TechDraw_NewSection| section views]].
* '''Section Line Style''': Style for section lines.
* '''Section Line Style''': Style for section lines.
* '''Section Cut Surface''': Style for section cut surface. The options are: {{Version|0.19}}
** ''Hide'': There is no visible surface.
** ''Solid Color'': The surface gets the color set for '''Section Face'''
** ''SVG Hatch'': The surface is [[TechDraw_Hatch|hatched]].
** ''PAT Hatch'': The surface is [[TechDraw_GeometricHatch|geometrically hatched]].
* '''Line Group Name''': Name of the default [[TechDraw_LineGroup|line group specification]].
* '''Line Group Name''': Name of the default [[TechDraw_LineGroup|line group specification]].
* '''Matting Style''': Outline shape for [[TechDraw_NewDetail|detail views]].
* '''Detail View Outline Shape''': Outline shape for [[TechDraw_DetailView|detail views]].
* '''Detail Highlight Style''': Line style of the outline shape for [[TechDraw_DetailView|detail views]]. {{Version|0.19}}
* '''Center Line Style''': Default style for [[TechDraw_FaceCenterLine|centerlines]].
* '''Center Line Style''': Default style for [[TechDraw_FaceCenterLine|centerlines]].
* '''Balloon Shape''': Shape of [[TechDraw_Balloon|balloon annotations]].
* '''Balloon Shape''': Shape of [[TechDraw_Balloon|balloon annotations]].
* '''Balloon Leader End''': Default style for balloon leader line ends.
* '''Balloon Leader End''': Default style for balloon leader line ends.
* '''Balloon Leader Kink Length''': Length of balloon leader line kink.
* '''Balloon Leader Kink Length''': Length of balloon leader line kink.
* '''Balloon Pyramid Vertical''': Keep pyramid leader line end in vertical or horizontal position.??
* '''Balloon Orthogonal Triangle''': If '''Balloon Leader End''' is ''Filled Triangle'', the triangle can only get a vertical or horizontal direction when the balloon is moved.
* '''Leader Line Auto Horizontal''': Forces last [[TechDraw_LeaderLine|leader line]] segment to be horizontal.
* '''Leader Line Auto Horizontal''': Forces last [[TechDraw_LeaderLine|leader line]] segment to be horizontal.
* '''Show Center Marks''': Show arc center marks in views.
* '''Show Center Marks''': Show arc center marks in views.
* '''Print Center Marks''': Show arc centers in printed output.
* '''Print Center Marks''': Show arc centers in printed output.


===Conventions=== <!--T:46-->
==Colors== <!--T:8-->


<!--T:47-->
<!--T:62-->
[[Image:TechDraw_Preferences_Colors.PNG|thumb|350px|Colors preferences]]
* '''Projection Group Angle''': If [[TechDraw_ProjectionGroup|projection groups]] will use either first- or third-angle projection. See [https://en.wikipedia.org/wiki/Multiview_projection#Multiviews multiview projection] for an explanation.

* '''Hidden Line Style''': The style to be used for hidden lines.
<!--T:13-->
Setup of the default colors for new pages:

<!--T:63-->
* '''Normal''': Normal line color.
* '''Preselected''': Preselection color. The color that is used to highlight objects when hovering with the mouse over them.
* '''Selected''': Color for selected objects.
* '''Background''': Background color around pages.
* '''Dimension''': Color of dimension lines and text.
* '''Centerline''': Color for [[TechDraw_FaceCenterLine|centerlines]].
* '''Detail Highlight''': Line color for the outline shape of [[TechDraw_DetailView|detail views]]. {{Version|0.19}}
* '''Transparent Faces''': If checked, object faces will be transparent. Otherwise the set color will be used for faces. {{Version|0.19}}
* '''Hidden Line''': Hidden line color. This color will be used for all kinds of [[#HLR Parameters|hidden lines]].
* '''Section Face''': Color of the [[TechDraw_SectionView|section view]] cut surface. Only used if the setting '''Section Cut Surface''' is set to ''Solid Color''.
* '''Section Line''': Color of the [[TechDraw_SectionView|section view]] cut line.
* '''Hatch''': [[TechDraw_Hatch|Hatch]] image color.
* '''Geometric Hatch''': [[TechDraw_GeometricHatch|Geometric hatch]] pattern color.
* '''Vertex''': Color of the selectable [[Glossary#V|vertices]] in views.
* '''Leaderline''': Color for new [[TechDraw_LeaderLine|leaderlines]].


== HLR Parameters== <!--T:48-->
== HLR== <!--T:48-->


<!--T:55-->
<!--T:55-->
[[Image:TechDraw_Preferences5.png|thumb|350px]]
[[Image:TechDraw_PreferencesHLR.png|thumb|350px|HLR preferences]]


<!--T:58-->
HLR stands for ''hidden line removal''.
HLR stands for ''hidden line removal''.


<!--T:59-->
* '''Use Polygon Approximation''': Uses an approximation to find hidden lines. This is fast, but the result is a collection of short straight lines.
* '''Use Polygon Approximation''': Uses an approximation to find hidden lines. This is fast, but the result is a collection of short straight lines.
* '''Show Hard Lines''': Shows hard and outline edges (visible lines always shown)
* '''Show Hard Lines''': Shows hard and outline edges (visible lines always shown)
* '''Show Smooth Lines''': Shows smooth lines. A smooth line is ??
* '''Show Smooth Lines''': Shows smooth lines. A smooth line is a line indicating a change between tangent surfaces, as in the transition from a flat surface to a [https://en.wikipedia.org/wiki/Fillet_(mechanics) fillet].
* '''Show Seam Lines''': Show seam lines. A seam line is ??
* '''Show Seam Lines''': Show seam lines. A seam line is a boundary between faces.
* '''Show UV ISO Lines''': Shows ISO lines. ISO stands for ''isoparametric''. [https://knowledge.autodesk.com/support/alias-products/learn-explore/caas/CloudHelp/cloudhelp/2014/ENU/Alias/files/GUID-4CCDF144-DB4F-4BEB-BA5A-E69CED27F4B9-htm.html Here is a description] what isoparametric lines (in fact curves) are.
* '''Show UV ISO Lines''': Make lines of equal parameterization.??
* '''ISO Count''': The number of ISO lines per face edge. An ISO line is ??
* '''ISO Count''': The number of ISO lines per face edge.


== Advanced== <!--T:50-->
== Advanced== <!--T:50-->


<!--T:56-->
<!--T:56-->
[[Image:TechDraw_Preferences4.png|thumb|350px]]
[[Image:TechDraw_PreferencesAdvanced.png|thumb|350px|Advanced preferences]]


<!--T:60-->
* '''Detect Faces''': If checked, TechDraw will attempt to build faces using the line segments returned by the hidden line removal algorithm. Faces must be detected in order to use [[TechDraw_Hatching|Hatching]], but there can be a performance penalty in complex models.
* '''Detect Faces''': If checked, TechDraw will attempt to build faces using the line segments returned by the hidden line removal algorithm. Faces must be detected in order to use [[TechDraw_Hatching|hatching]], but there can be a performance penalty in complex models.
* '''Show Section Edges''': Highlights the border of the section cut in [[Image:TechDraw_SectionView.svg|16px]] [[TechDraw_SectionView|Section Views]].
* '''Show Section Edges''': Highlights the border of the section cut in [[TechDraw_SectionView|section views]].
* '''Debug Section''': Dumps intermediate results during a Section view processing
* '''Debug Section''': Dumps intermediate results during a Section view processing
* '''Debug Detail''': Dumps intermediate results during a Detail view processing
* '''Debug Detail''': Dumps intermediate results during a Detail view processing

Revision as of 11:17, 3 May 2020

Introduction

The preferences of the TechDraw Workbench are found in the Preferences Editor, Edit → Preferences → TechDraw.

All preferences settings with italic labels are default values for new drawing objects. They have no effect on existing objects.

General

General preferences

Drawing Update

introduced in version 0.19

  • Update With 3D: Whether or not pages are updated every time the 3D model is changed. This is a global policy setting.
  • Allow Page Override: Whether or not a page's Keep Update property can override the global Update With 3D parameter. This is a global policy setting.
  • Keep Page Up To Date: Keeps drawing pages in sync with changes of the 3D model in real time. This can slow down the response time.
  • Auto-distribute Secondary Views: Automatically distributes secondary views for projection groups.

Labels

  • Label Font: The name of the default font for labels.
  • Label Size: Default size for label text.

Files

Scale

Scale preferences

Scale

  • Page Scale: Default scale for new pages.
  • View Scale Type: Default scale for new views.
  • View Custom Scale: Default scale for views if View Scale Type is Custom.

Selection

  • Edge Fuzz: Size of selection area around edges. The fuzz unit is approximately 0.1 mm, depending on your current zoom.
  • Mark Fuzz: Selection area around center marks. The fuzz unit is approximately 0.1 mm, depending on your current zoom.

Size Adjustments

  • Vertex Scale: Scale of vertex dots. Multiplier of line width.
  • Center Mark Scale: Size of center marks. Multiplier of vertex size.
  • Tolerance Text Scale: Tolerance font size adjustment. Multiplier of dimension Font Size.
  • Template Edit Mark: Size of template field click handles in mm (green dots).
  • Welding Symbol Scale: Multiplier for size of welding symbols. introduced in version 0.19

Dimensions

Dimensions preferences

Dimensions

  • Standard and Style: The standard to be used for dimensional values. The difference between the standards are shown in the image:
    Differences between the supported standards
  • Use Global Decimals: Use number of decimals from the general preferences.
  • Show Units: Appends the unit (mm, in, etc.) to dimension values.
  • Alternate Decimals: Number of decimals if Use Global Decimals is not used.
  • Default Format: Custom format for dimension text. Uses the printf format specifier.
  • Font Size: Font size for dimension text.
  • Diameter Symbol: Character used to indicate diameter dimensions.
  • Arrow Style: Arrowhead style for dimensions.
  • Arrow Size: Arrowhead size of dimensions.

Conventions

  • Projection Group Angle: If projection groups will use either first- or third-angle projection. See multiview projection for an explanation.
  • Hidden Line Style: The style to be used for hidden lines.

Annotation

Annotation preferences
  • Section Line Standard: Standard to be used to draw section lines in section views.
  • Section Line Style: Style for section lines.
  • Section Cut Surface: Style for section cut surface. The options are: introduced in version 0.19
    • Hide: There is no visible surface.
    • Solid Color: The surface gets the color set for Section Face
    • SVG Hatch: The surface is hatched.
    • PAT Hatch: The surface is geometrically hatched.
  • Line Group Name: Name of the default line group specification.
  • Detail View Outline Shape: Outline shape for detail views.
  • Detail Highlight Style: Line style of the outline shape for detail views. introduced in version 0.19
  • Center Line Style: Default style for centerlines.
  • Balloon Shape: Shape of balloon annotations.
  • Balloon Leader End: Default style for balloon leader line ends.
  • Balloon Leader Kink Length: Length of balloon leader line kink.
  • Balloon Orthogonal Triangle: If Balloon Leader End is Filled Triangle, the triangle can only get a vertical or horizontal direction when the balloon is moved.
  • Leader Line Auto Horizontal: Forces last leader line segment to be horizontal.
  • Show Center Marks: Show arc center marks in views.
  • Print Center Marks: Show arc centers in printed output.

Colors

Colors preferences

Setup of the default colors for new pages:

  • Normal: Normal line color.
  • Preselected: Preselection color. The color that is used to highlight objects when hovering with the mouse over them.
  • Selected: Color for selected objects.
  • Background: Background color around pages.
  • Dimension: Color of dimension lines and text.
  • Centerline: Color for centerlines.
  • Detail Highlight: Line color for the outline shape of detail views. introduced in version 0.19
  • Transparent Faces: If checked, object faces will be transparent. Otherwise the set color will be used for faces. introduced in version 0.19
  • Hidden Line: Hidden line color. This color will be used for all kinds of hidden lines.
  • Section Face: Color of the section view cut surface. Only used if the setting Section Cut Surface is set to Solid Color.
  • Section Line: Color of the section view cut line.
  • Hatch: Hatch image color.
  • Geometric Hatch: Geometric hatch pattern color.
  • Vertex: Color of the selectable vertices in views.
  • Leaderline: Color for new leaderlines.

HLR

HLR preferences

HLR stands for hidden line removal.

  • Use Polygon Approximation: Uses an approximation to find hidden lines. This is fast, but the result is a collection of short straight lines.
  • Show Hard Lines: Shows hard and outline edges (visible lines always shown)
  • Show Smooth Lines: Shows smooth lines. A smooth line is a line indicating a change between tangent surfaces, as in the transition from a flat surface to a fillet.
  • Show Seam Lines: Show seam lines. A seam line is a boundary between faces.
  • Show UV ISO Lines: Shows ISO lines. ISO stands for isoparametric. Here is a description what isoparametric lines (in fact curves) are.
  • ISO Count: The number of ISO lines per face edge.

Advanced

Advanced preferences
  • Detect Faces: If checked, TechDraw will attempt to build faces using the line segments returned by the hidden line removal algorithm. Faces must be detected in order to use hatching, but there can be a performance penalty in complex models.
  • Show Section Edges: Highlights the border of the section cut in section views.
  • Debug Section: Dumps intermediate results during a Section view processing
  • Debug Detail: Dumps intermediate results during a Detail view processing
  • Allow Crazy Edges: Includes edges with unexpected geometry in results, e.g. zero lengths
  • Fuse Before Section: Performs a fuse operation on the input shape(s) before Section view processing
  • Show Loose 2D Geom: Includes 2D Objects in projections, e.g. loose sketches
  • Line End Cap Shape: Setting of the line end cap shape. Explanation of the options: https://doc.qt.io/qt-5/qt.html#PenCapStyle-enum
  • Max SVG Hatch Tiles: The limit of SVG tiles with a size of 64x64 pixels used to hatch a single face. For large scalings one might get an error about to many SVG tiles, then one needs to increase the tile limit.
  • Max PAT Hatch Segments: The maximum hatch line segments used when hatching a face with a PAT pattern.

Hidden Settings

Note: Since FreeCAD 0.19, all settings are available in the Preferences dialogs. The following only applies for FreeCAD versions older than 0.19:

Some preference settings are only accessible through the Parameter editor, Tools → Edit parameters.

Preferences/Mod/TechDraw/Decorations

  • CenterMarkScale: default scale factor for CenterMarks
  • ShowCenterMarks: default true/false
  • PrintCenterMarks: true/false show CenterMarks when printing introduced in version 0.19

Preferences/Mod/TechDraw/General

  • DefaultScale: initial setting of Page Scale introduced in version 0.19
  • EdgeFuzz: pick radius for Edges
  • MarkFuzz: pick radius for CenterMarks
  • SectionFuseFirst: fuse Source objects before performing Section cut
  • EdgeEndCap: shape of Edge ends 0x00 FlatCap, 0x10 SquareCap, 0x20 RoundCap (Qt::PenCapStyle) introduced in version 0.19

Preferences/Mod/TechDraw/Format

  • SectionFormat: section line style 0-ASME 1-ISO

Preferences/Mod/TechDraw/Standards

  • RadiusAligned: Radius dimension format 0-ISO(aligned) 1-ASME(uniform)