Fine-tuning: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Marked this version for translation)
 
(78 intermediate revisions by 8 users not shown)
Line 6: Line 6:
<translate>
<translate>


<!--T:1-->
== Introduction == <!--T:23-->
This page holds different settings and parameters that you can use to fine-tune your FreeCAD installation or overcome problems.

== Option parameters == <!--T:2-->


<!--T:3-->
<!--T:3-->
Line 18: Line 15:


<!--T:5-->
<!--T:5-->
The list below shows parameters that are not accessible via the preferences editor, but that you can set manually (located in '''BaseApp/Preferences''')
This page lists parameters that are not accessible via the preferences editor, but that you can set manually to fine-tune your FreeCAD installation or overcome problems. All parameters are located in '''BaseApp/Preferences/'''.

== General == <!--T:24-->


<!--T:6-->
<!--T:6-->
<!--Please keep the settings in an A-Z order-->
<!--Please keep the settings in an A-Z order-->
* '''Bitmaps/Theme/ThemeSearchPaths''' (boolean): Set to {{FALSE}} so FreeCAD uses it's included icons instead of the system icon theme on Linux.
* '''Addons/developerMode''' (boolean): Set to {{TRUE}} to enable the developer mode of the [[Std AddonMgr|Addon Manager]]. See [[Package_Metadata#Validation|Package Metadata]].
* '''Bitmaps/Theme/ThemeSearchPaths''' (boolean): Set to {{FALSE}} so FreeCAD uses its included icons instead of the system icon theme on Linux.
* '''Dialog/DontUseNativeColorDialog''' (boolean): Color picker dialog setting. Set to {{FALSE}} if you want FreeCAD to use the native color dialog on your system rather than the Qt Color Dialog. Defaults to {{TRUE}}.
* '''Dialog/DontUseNativeDialog''' (boolean): File dialog setting. Set to {{FALSE}} if you want to use the native File dialog when opening files or to {{TRUE}} to use the Qt File Picker Dialog. Default depends on a compile time setting: #define (USE_QT_FILEDIALOG).
* '''Dialog/DontUseNativeFontDialog''' (boolean): Used by the [[Draft_ShapeString|Draft ShapeString]] command. Set to {{FALSE}} to use the native Font dialog. Defaults to {{TRUE}}.
* '''DockWindows/DAGView/Enabled''' (boolean): Set to {{TRUE}} to enable a beta [[DAG_view|DAG view]] dockable widget. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''DockWindows/DAGView/Enabled''' (boolean): Set to {{TRUE}} to enable a beta [[DAG_view|DAG view]] dockable widget. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''DockWindows/PropertyView/Enabled''' (boolean): Set to {{TRUE}} to enable a [[Property_editor|Property View]] dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''DockWindows/PropertyView/Enabled''' (boolean): Set to {{TRUE}} to enable a [[Property_editor|Property View]] dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''DockWindows/TreeView/Enabled''' (boolean): Set to {{TRUE}} to enable a [[Document_structure|Tree View]] dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''DockWindows/TreeView/Enabled''' (boolean): Set to {{TRUE}} to enable a [[Document_structure|Tree View]] dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
* '''Document/AutoNameDynamicProperty''' (boolean): Set to {{TRUE}} to make FreeCAD automatically rename dynamic properties with an invalid specified name instead of throwing an exception. Note that Python code will not have access to the new name.
* '''Document/ChangeViewProviderTouchDocument''' (boolean): Set to {{FALSE}} so items visibility changes won't mark the document as changed.
* '''Document/ChangeViewProviderTouchDocument''' (boolean): Set to {{FALSE}} so items visibility changes won't mark the document as changed.
* '''Document/SaveThumbnailFix''' (boolean): Set to {{TRUE}} to fix a problem with Qt5 that prevents the generation of {{incode|.FCStd}} file thumbnails.
* '''Document/SaveThumbnailFix''' (boolean): Set to {{TRUE}} to fix a problem with Qt5 that prevents the generation of {{incode|.FCStd}} file thumbnails.
Line 31: Line 35:
* '''General/RecentIncludesExported''' (boolean): Set to {{TRUE}} to include exported files in the Recent Files list. Defaults to {{FALSE}}.
* '''General/RecentIncludesExported''' (boolean): Set to {{TRUE}} to include exported files in the Recent Files list. Defaults to {{FALSE}}.
* '''General/RecentIncludesImported''' (boolean): Set to {{FALSE}} to exclude imported files from the Recent Files list. Defaults to {{TRUE}}.
* '''General/RecentIncludesImported''' (boolean): Set to {{FALSE}} to exclude imported files from the Recent Files list. Defaults to {{TRUE}}.
* '''General/ShowSplasherMessages''' (boolean): Set to {{FALSE}} to skip showing messages on the splashscreen. This may reduce the FreeCAD startup time. Defaults to {{TRUE}}.
* '''General/SubstituteDecimalSeparator''' (boolean): If set to {{TRUE}}, the dot/period key will be substituted with the regional decimal separator when entering a number in a spin box. Substitution will only happen if dot isn't your regional decimal separator and at least one of the following conditions applies: dot isn't your regional thousand separator or dot was entered from the numerical pad. Defaults to {{FALSE}}.
* '''Macro/DuplicateFrom001''' (boolean): Set to {{TRUE}} to always begin searching for suggested duplicate macro filename with @001 instead of current @NNN, if applicable. Defaults to {{FALSE}}.
* '''Macro/DuplicateFrom001''' (boolean): Set to {{TRUE}} to always begin searching for suggested duplicate macro filename with @001 instead of current @NNN, if applicable. Defaults to {{FALSE}}.
* '''Macro/DuplicateIgnoreExtraNote''' (boolean): Set to {{TRUE}} to ignore extra note when suggesting duplicate macro filename. Extra note is text in the filename following "@NNN" and before ".FCMacro". Example: "my_macro@005.my_note.FCMacro". If {{TRUE}} the next suggested filename is "my_macro@006.FCMacro". If set to {{FALSE}} the next suggested filename is "my_macro@006.my_note.FCMacro". To be recognized as an extra note the text should begin with a dot (".") following the "@NNN". Otherwise, for example "my_macro@006_my_note.FCMacro" gets "my_macro@006_my_note@001.FCMacro" as suggested new filename, which might be desirable in some cases. Defaults to {{FALSE}}.
* '''Macro/DuplicateIgnoreExtraNote''' (boolean): Set to {{TRUE}} to ignore extra note when suggesting duplicate macro filename. Extra note is text in the filename following "@NNN" and before ".FCMacro". Example: "my_macro@005.my_note.FCMacro". If {{TRUE}} the next suggested filename is "my_macro@006.FCMacro". If set to {{FALSE}} the next suggested filename is "my_macro@006.my_note.FCMacro". To be recognized as an extra note the text should begin with a dot (".") following the "@NNN". Otherwise, for example "my_macro@006_my_note.FCMacro" gets "my_macro@006_my_note@001.FCMacro" as suggested new filename, which might be desirable in some cases. Defaults to {{FALSE}}.
* '''Macro/ReplaceSpaces''' (boolean): Set to {{FALSE}} if you do not want spaces in your filenames automatically converted to underscores when creating, renaming, or duplicating a macro. Does not affect existing files, only matters when creating new file or renaming or duplicating existing file. Defaults to {{TRUE}}.
* '''Macro/ReplaceSpaces''' (boolean): Set to {{FALSE}} if you do not want spaces in your filenames automatically converted to underscores when creating, renaming, or duplicating a macro. Does not affect existing files, only matters when creating new file or renaming or duplicating existing file. Defaults to {{TRUE}}.
* '''MainWindow/ClearMenuBar''' (boolean): Set to {{TRUE}} to clear the menu bar on workbench change, useful when using a global menu as they may fail to update on workbench change and quickly get cluttered with each workbench's menu entries. Defaults to {{FALSE}}. On macOS it is cleared either way to workaround a Qt bug.
* '''Mod/Draft/defaultCameraHeight''' (int): Sets the height of the camera when Draft starts in an empty document. 0 disables, FreeCAD default is 5, good when working in millimeters, a good height for arch work is 4500.
* '''Mod/Part/ParametricRefine''' (boolean): Set to {{FALSE}} so [[Part_RefineShape|Part RefineShape]] creates an independent copy rather than a linked one. Defaults to {{TRUE}}.
* '''MainWindow/ToolBarNameAsToolTip''' (boolean): Set to {{FALSE}} to not get the toolbar name as a tooltip. Defaults to {{TRUE}}.
* '''Mod/PartDesign/AdditiveHelixPreview''' (boolean): Set to {{TRUE}} to ensure an additive helix that does not intersect the body is visible in the preview. Defaults to {{FALSE}}.
* '''Mod/PartDesign/SubtractiveHelixPreview''' (boolean): Set to {{TRUE}} to ensure a subtractive helix that does not intersect the body is visible in the preview. Defaults to {{TRUE}}.
* '''Mod/PartDesign/SwitchToTask''' (boolean): Set to {{FALSE}} to prevent the [[PartDesign_Workbench|PartDesign Workbench]] from switching to the Task panel when starting. Defaults to {{TRUE}}.
* '''Mod/PartDesign/SwitchToWB''' (boolean): Set to {{FALSE}} to prevent the [[PartDesign_Workbench|PartDesign Workbench]] to be automatically called when a [[PartDesign_Body|PartDesign Body]] is activated. Defaults to {{TRUE}}.
* '''Mod/Sketcher/RadiusDiameterConstraintDisplayBaseAngle''' (float): Set the angle (from horizontal) used to display radius/diameter constraints in Sketcher at creation time. Default is 15 degrees (if no value set).
* '''Mod/Sketcher/RadiusDiameterConstraintDisplayAngleRandomness''' (float): Set an angle randomness on the above value. Value is the range of the random angle, centered on base angle. Default is 0 degree -- disabled -- (if no value set).
* '''PropertyView/AutoTransactionView''' (boolean): Set to {{TRUE}} so changes of View tab properties are added to the undo stack (hence are undoable). Defaults to {{FALSE}}.
* '''PropertyView/AutoTransactionView''' (boolean): Set to {{TRUE}} so changes of View tab properties are added to the undo stack (hence are undoable). Defaults to {{FALSE}}.
* '''Selection/AutoShowSelectionView''' (boolean): Set to {{TRUE}} to make the Selection View pane show automatically when selecting something. Defaults to {{FALSE}}.
* '''Selection/AutoShowSelectionView''' (boolean): Set to {{TRUE}} to make the Selection View pane show automatically when selecting something. Defaults to {{FALSE}}.
* '''View/NavigationDebug''' (boolean): enables debug output of navigation styles (as of v0.19, only Gesture navigation style has something to say).
* '''Selection/singleClickFeatureSelect''' (boolean): Set to {{FALSE}} to disable single click selection of a feature in PartDesign. Defaults to {{TRUE}}.
* '''TreeView/HideColumn''' (boolean): Set to {{True}} to hide the 'Description' column in the [[Tree_view|Tree view]]. Defaults to {{FALSE}}.
* '''TreeView/TreeViewStretchDescription''' (boolean): Set to {{TRUE}} to stretch the 'Description' column in the [[Tree_view|Tree view]] to the right edge of the pane. Defaults to {{FALSE}}.
* '''View/AxisLetterColor''' (unsigned): Color for the letters of the coordinate system shown in the lower right corner of the 3D view. Defaults to {{Value|255}}. See [[Navigation_Cube#Customization|here]] for information about the color value.
* '''View/AxisXColor''' (unsigned): Color for the X axis elements of the [[Std_TransformManip|Std TransformManip]] gizmo. Defaults to {{Value|3425907456}}. See [[Navigation_Cube#Customization|here]] for information about the color value.
* '''View/AxisYColor''' (unsigned): Idem for the Y axis elements. Defaults to {{Value|869020416}}.
* '''View/AxisZColor''' (unsigned): Idem for the Z axis elements. Defaults to {{Value|859032576}}.
* '''View/NavigationDebug''' (boolean): Enables debug output of navigation styles (as of v0.19, only Gesture navigation style has something to say).
* '''View/SavePicture''' (string): Set to '''FramebufferObject''', '''PixelBuffer''' or '''CoinOffscreenRenderer''' for different methods to produce images from the 3D view.
* '''View/SavePicture''' (string): Set to '''FramebufferObject''', '''PixelBuffer''' or '''CoinOffscreenRenderer''' for different methods to produce images from the 3D view.


=== Export Default Filename === <!--T:19-->
== Default export filename == <!--T:19-->


<!--T:17-->
<!--T:17-->
<!--Please keep the settings in an A-Z order-->
<!--Please keep the settings in an A-Z order-->
* '''General/ExportDefaultFilenameMultiple''' (string): Set the default filename to use when exporting multiple objects. Defaults to "%F".
* '''General/ExportDefaultFilenameMultiple''' (string): Set the default filename to use when exporting multiple objects. Defaults to {{Value|%F}}.
* '''General/ExportDefaultFilenameSingle''' (string): Set the default filename to use when exporting a single object. Defaults to "%F-%P-".
* '''General/ExportDefaultFilenameSingle''' (string): Set the default filename to use when exporting a single object. Defaults to {{Value|%F-%P-}}.


<!--T:18-->
<!--T:18-->
Line 63: Line 68:
* %D - the date and time, in local timezone, [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]
* %D - the date and time, in local timezone, [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]
Any other characters are treated literally. If the resulting filename is illegal it will be changed on saving, with illegal characters replaced by the underscore (_).
Any other characters are treated literally. If the resulting filename is illegal it will be changed on saving, with illegal characters replaced by the underscore (_).

=== Sketcher Constraint Label Colors ===

The label in Sketcher that displays the current status of the constraints (e.g. "Underconstrained," "Overconstrained," "Fully Constrained," etc.) is styleable on a per-state basis either using the Qt stylesheet, or via user preferences. User preferences take precedence if they have been set (in '''Mod/Sketcher/General'''):
<!-- These are listed in "priority"/"severity" order, rather than alphabetical -->
* '''EmptySketchMessageColor''' - Defaults to 50% opacity black
* '''UnderconstrainedMessageColor''' - Defaults to black
* '''MalformedConstraintMessageColor''' - Defaults to red
* '''ConflictingConstraintMessageColor''' - Defaults to red
* '''RedundantConstraintMessageColor''' - Defaults to orange red
* '''PartiallyRedundantConstraintMessageColor''' - Defaults to royal blue
* '''SolverFailedMessageColor''' - Defaults to red
* '''FullyConstrainedMessageColor''' - Defaults to green


== Mouse related == <!--T:9-->
== Mouse related == <!--T:9-->
Line 81: Line 73:
<!--T:10-->
<!--T:10-->
<!--Please keep the settings in an A-Z order-->
<!--Please keep the settings in an A-Z order-->
* '''General/ComboBoxWheelEventFilter''' (boolean): Set to {{TRUE}} so widgets do not catch mouse wheel event and prevent scrollable areas to be scrolled.
* '''General/ComboBoxWheelEventFilter''' (boolean): Set to {{TRUE}} so widgets do not catch mouse wheel event and prevent scrollable areas to be scrolled. Needs FreeCAD restart to be taken into account.
* '''View/GestureMoveThreshold''' (integer): the distance (px) mouse cursor has to move to enter rotation or pan modes of Gesture navigation style. Default is 5.
* '''View/GestureMoveThreshold''' (integer): the distance (px) mouse cursor has to move to enter rotation or pan modes of Gesture navigation style. Defaults to {{Value|5}}.
* '''View/GestureRollFwdCommand''', '''View/GestureRollBackCommand''' (string): commands to be executed by mouse button roll gestures of Gesture navigation style.
* '''View/GestureRollFwdCommand''', '''View/GestureRollBackCommand''' (string): commands to be executed by mouse button roll gestures of Gesture navigation style.
* '''View/GestureTapHoldTimeout''' (integer): sets for how long to wait (in milliseconds) to enter pan mode in Gesture navigation style. It can be helpful to increase it if dragging geometry in sketcher is difficult. Default is 700.
* '''View/GestureTapHoldTimeout''' (integer): sets for how long to wait (in milliseconds) to enter pan mode in Gesture navigation style. It can be helpful to increase it if dragging geometry in sketcher is difficult. Defaults to {{Value|700}}.


== Keyboard Shortcuts == <!--T:11-->
== Keyboard shortcuts == <!--T:11-->


=== Escape Key === <!--T:20-->
=== Escape key === <!--T:20-->


<!--T:12-->
<!--T:12-->
<!--Please keep the settings in an A-Z order-->
<!--Please keep the settings in an A-Z order-->
* '''General/TasksKeyEsc''' (boolean): Create and set to {{FALSE}} to disable the {{KEY|ESC}} key exiting the [[Task_panel|Task panel]] in all workbenches (that is if the task panel has focus). '''Note:''' Superceded by [[Sketcher_Preferences#General|Sketcher Preferences]].
* '''General/TasksKeyEsc''' (boolean): Create and set to {{FALSE}} to disable the {{KEY|ESC}} key exiting the [[Task_panel|Task panel]] in all workbenches (that is if the task panel has focus).

* '''Mod/Sketcher/ViewKeyEsc''' (boolean): Create and set to {{FALSE}} to disable {{KEY|ESC}} key issues with pressing one to many times, when escaping sketcher geometry/constraints creation continue mode (see [https://forum.freecadweb.org/viewtopic.php?f=3&t=42207&start=60#p367584 forum thread])
== Navigation Cube == <!--T:41-->

<!--T:42-->
See [[Navigation_Cube#Advanced_parameters|Navigation Cube]].

== Specific workbenches == <!--T:13-->

=== [[Image:Workbench_BIM.svg|24px|link=BIM_Workbench]] [[BIM_Workbench|BIM Workbench]] === <!--T:25-->

<!--T:26-->
* '''Mod/BIM/DefaultPageScale''' (float): Default scaling for new TechDraw pages created from the BIM Workbench, in case the template doesn't contain any "Scale" or "Scaling" (case insensitive) editable text field.

=== [[Image:Workbench_CAM.svg|24px|link=CAM_Workbench]] [[CAM_Workbench|CAM Workbench]] === <!--T:46-->

<!--T:34-->
* The [[CAM_Workbench|CAM Workbench]] has two switches to enable experimental features documented on the [[CAM_experimental|CAM experimental]] page.

=== [[Image:Workbench_Draft.svg|24px|link=Draft_Workbench]] [[Draft_Workbench|Draft Workbench]] === <!--T:27-->

<!--T:43-->
* '''Mod/Draft/DefaultAnnoDisplayMode''' (integer): Set to {{Value|1}} to create Draft annotations ([[Draft_Text|texts]], [[Draft Dimension|dimensions]] and [[Draft Label|labels]]) with their {{PropertyView|Display Mode}} set to {{Value|Screen}}. Set to {{Value|0}} for new annotations with this property set to {{Value|World}}. Defaults to {{Value|0}}. {{Version|0.22}}
* '''Mod/Draft/GridHideInOtherWorkbenches''' (boolean): Set to {{FALSE}} to keep the [[Draft_ToggleGrid|Draft grid]] when switching to workbenches other than [[Arch Workbench|Arch]], [[BIM Workbench|BIM]] or [[Draft Workbench|Draft]]. Defaults to {{TRUE}}. {{Version|0.22}}
* '''Mod/Draft/useSupport''' (boolean): Set to {{TRUE}} to set the {{PropertyData|Support}} property of Draft objects created on a face of an exiting base object to that base object. This was standard behavior before FreeCAD version 0.19. Note that this parameter may not be supported in future versions. Defaults to {{FALSE}}.

=== [[Image:Workbench_Part.svg|24px|link=Part_Workbench]] [[Part_Workbench|Part Workbench]] === <!--T:29-->

<!--T:30-->
* '''Mod/Part/ParametricRefine''' (boolean): Set to {{FALSE}} so [[Part_RefineShape|Part RefineShape]] creates an independent copy rather than a linked one. Defaults to {{TRUE}}.

=== [[Image:Workbench_PartDesign.svg|24px|link=PartDesign_Workbench]] [[PartDesign_Workbench|PartDesign Workbench]] === <!--T:31-->

<!--T:32-->
* '''Mod/PartDesign/AdditiveHelixPreview''' (boolean): Set to {{TRUE}} to ensure an additive helix that does not intersect the body is visible in the preview. Defaults to {{FALSE}}.
* '''Mod/PartDesign/SubtractiveHelixPreview''' (boolean): Set to {{TRUE}} to ensure a subtractive helix that does not intersect the body is visible in the preview. Defaults to {{TRUE}}.
* '''Mod/PartDesign/SwitchToTask''' (boolean): Set to {{FALSE}} to prevent the [[PartDesign_Workbench|PartDesign Workbench]] from switching to the Task panel when starting. Defaults to {{TRUE}}.
* '''Mod/PartDesign/SwitchToWB''' (boolean): Set to {{FALSE}} to prevent the [[PartDesign_Workbench|PartDesign Workbench]] to be automatically called when a [[PartDesign_Body|PartDesign Body]] is activated. Defaults to {{TRUE}}.

=== [[Image:Workbench_Sketcher.svg|24px|link=Sketcher_Workbench]] [[Sketcher_Workbench|Sketcher Workbench]] === <!--T:35-->

<!--T:36-->
* '''Mod/Sketcher/RadiusDiameterConstraintDisplayAngleRandomness''' (float): Set an angle randomness on the above value. Value is the range of the random angle, centered on base angle. Defaults to {{Value|0}}.
* '''Mod/Sketcher/RadiusDiameterConstraintDisplayBaseAngle''' (float): Set the angle (from horizontal) used to display radius/diameter constraints in Sketcher at creation time. Defaults to {{Value|15}}.
* '''Mod/Sketcher/RoundRectangleSuggConstraints''' (boolean): Set to {{FALSE}} to disable the addition of two extra construction points when creating a rounded rectangle. {{Version|0.21}}

==== Constraint label colors ==== <!--T:21-->

<!--T:22-->
The label in Sketcher that displays the current status of the constraints (e.g. "Underconstrained," "Fully Constrained," etc.) is styleable on a per-state basis either using the Qt stylesheet, or via user preferences. User preferences take precedence if they have been set (in '''Mod/Sketcher/General'''):
<!-- These are listed in "priority"/"severity" order, rather than alphabetical -->
* '''EmptySketchMessageColor''' - Defaults to 50% opacity black
* '''UnderconstrainedMessageColor''' - Defaults to black
* '''MalformedConstraintMessageColor''' - Defaults to red
* '''ConflictingConstraintMessageColor''' - Defaults to red
* '''RedundantConstraintMessageColor''' - Defaults to orange red
* '''PartiallyRedundantConstraintMessageColor''' - Defaults to royal blue
* '''SolverFailedMessageColor''' - Defaults to red
* '''FullyConstrainedMessageColor''' - Defaults to green


=== [[Image:Workbench_Start.svg|24px|link=Start_Workbench]] [[Start_Workbench|Start Workbench]] === <!--T:37-->
== Specific Workbenches == <!--T:13-->


<!--T:14-->
<!--T:38-->
* '''Mod/Start/DefaultImportXXX''' (string): Where XXX is a lowercase file extension. For example DefaultImportifc for .IFC files. Allows to set a default import module to be used when clicking an icon on the start page, when several importers are available. For example, setting DefaultImportifc = ifc_import will use the NativeIFC importer if available. {{Version|0.21}}
* [[Image:Workbench_TechDraw.svg|16px|link=TechDraw_Workbench]] [[TechDraw_Workbench|TechDraw Workbench]] has several hidden switches documented in [[TechDraw_Preferences#Hidden_Settings|TechDraw Preferences]].
* '''Mod/Start/TimeFormat''' (string): A time format string such as {{Value|%m/%d/%Y %H:%M:%S}} used for the date in the tooltip that is shown when an item on the start page is hovered.
* [[Image:Workbench_Path.svg|16px|link=Path_Workbench]] [[Path_Workbench|Path Workbench]] has a switch to enable experimental features documented in [[Path_experimental|Path experimental]].
* [[Image:Workbench_BIM.svg|16px|link=BIM_Workbench]] [[BIM_Workbench|BIM Workbench]]:
** '''Mod/BIM/DefaultPageScale''' (float): Default scaling for new TechDraw pages created from the BIM Workbench, in case the template doesn't contain any "Scale" or "Scaling" (text insensitive) editable text field.


== Related == <!--T:15-->
=== [[Help_Module|Help Module]] === <!--T:45-->


<!--T:16-->
<!--T:44-->
* '''Mod/Help/UseWebModule''' (boolean): Allows to force the use of the Web module to open MDI tabs. This can be useful to work around QWebEngine issues in some versions of Qt5. Defaults to {{FALSE}}. {{Version|0.22}}
* [[Std_DlgParameter|Parameter editor]]
* [[Preferences_editor|Preferences editor]]




Latest revision as of 17:02, 18 April 2024

Other languages:

Introduction

The FreeCAD Preferences Editor under menu Edit → Preferences is commonly used to set and manipulate the FreeCAD parameters table.

However, it is also possible to access, modify and create parameters manually, using the Parameter Editor found under menu Tools → Edit parameters.

This page lists parameters that are not accessible via the preferences editor, but that you can set manually to fine-tune your FreeCAD installation or overcome problems. All parameters are located in BaseApp/Preferences/.

General

  • Addons/developerMode (boolean): Set to true to enable the developer mode of the Addon Manager. See Package Metadata.
  • Bitmaps/Theme/ThemeSearchPaths (boolean): Set to false so FreeCAD uses its included icons instead of the system icon theme on Linux.
  • Dialog/DontUseNativeColorDialog (boolean): Color picker dialog setting. Set to false if you want FreeCAD to use the native color dialog on your system rather than the Qt Color Dialog. Defaults to true.
  • Dialog/DontUseNativeDialog (boolean): File dialog setting. Set to false if you want to use the native File dialog when opening files or to true to use the Qt File Picker Dialog. Default depends on a compile time setting: #define (USE_QT_FILEDIALOG).
  • Dialog/DontUseNativeFontDialog (boolean): Used by the Draft ShapeString command. Set to false to use the native Font dialog. Defaults to true.
  • DockWindows/DAGView/Enabled (boolean): Set to true to enable a beta DAG view dockable widget. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
  • DockWindows/PropertyView/Enabled (boolean): Set to true to enable a Property View dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
  • DockWindows/TreeView/Enabled (boolean): Set to true to enable a Tree View dockable widget independent from the Combo View. After changing the parameter value, a FreeCAD restart is needed so the widget is available in the View/Panels list.
  • Document/AutoNameDynamicProperty (boolean): Set to true to make FreeCAD automatically rename dynamic properties with an invalid specified name instead of throwing an exception. Note that Python code will not have access to the new name.
  • Document/ChangeViewProviderTouchDocument (boolean): Set to false so items visibility changes won't mark the document as changed.
  • Document/SaveThumbnailFix (boolean): Set to true to fix a problem with Qt5 that prevents the generation of .FCStd file thumbnails.
  • General/LockToolBars (boolean): Set to true to prevent toolbars from being draggable, and to hide the small drag handles. Mostly used in conjunction with stylesheets that make the toolbars vertical.
  • General/RecentIncludesExported (boolean): Set to true to include exported files in the Recent Files list. Defaults to false.
  • General/RecentIncludesImported (boolean): Set to false to exclude imported files from the Recent Files list. Defaults to true.
  • General/ShowSplasherMessages (boolean): Set to false to skip showing messages on the splashscreen. This may reduce the FreeCAD startup time. Defaults to true.
  • Macro/DuplicateFrom001 (boolean): Set to true to always begin searching for suggested duplicate macro filename with @001 instead of current @NNN, if applicable. Defaults to false.
  • Macro/DuplicateIgnoreExtraNote (boolean): Set to true to ignore extra note when suggesting duplicate macro filename. Extra note is text in the filename following "@NNN" and before ".FCMacro". Example: "my_macro@005.my_note.FCMacro". If true the next suggested filename is "my_macro@006.FCMacro". If set to false the next suggested filename is "my_macro@006.my_note.FCMacro". To be recognized as an extra note the text should begin with a dot (".") following the "@NNN". Otherwise, for example "my_macro@006_my_note.FCMacro" gets "my_macro@006_my_note@001.FCMacro" as suggested new filename, which might be desirable in some cases. Defaults to false.
  • Macro/ReplaceSpaces (boolean): Set to false if you do not want spaces in your filenames automatically converted to underscores when creating, renaming, or duplicating a macro. Does not affect existing files, only matters when creating new file or renaming or duplicating existing file. Defaults to true.
  • MainWindow/ClearMenuBar (boolean): Set to true to clear the menu bar on workbench change, useful when using a global menu as they may fail to update on workbench change and quickly get cluttered with each workbench's menu entries. Defaults to false. On macOS it is cleared either way to workaround a Qt bug.
  • MainWindow/ToolBarNameAsToolTip (boolean): Set to false to not get the toolbar name as a tooltip. Defaults to true.
  • PropertyView/AutoTransactionView (boolean): Set to true so changes of View tab properties are added to the undo stack (hence are undoable). Defaults to false.
  • Selection/AutoShowSelectionView (boolean): Set to true to make the Selection View pane show automatically when selecting something. Defaults to false.
  • Selection/singleClickFeatureSelect (boolean): Set to false to disable single click selection of a feature in PartDesign. Defaults to true.
  • TreeView/HideColumn (boolean): Set to true to hide the 'Description' column in the Tree view. Defaults to false.
  • TreeView/TreeViewStretchDescription (boolean): Set to true to stretch the 'Description' column in the Tree view to the right edge of the pane. Defaults to false.
  • View/AxisLetterColor (unsigned): Color for the letters of the coordinate system shown in the lower right corner of the 3D view. Defaults to 255. See here for information about the color value.
  • View/AxisXColor (unsigned): Color for the X axis elements of the Std TransformManip gizmo. Defaults to 3425907456. See here for information about the color value.
  • View/AxisYColor (unsigned): Idem for the Y axis elements. Defaults to 869020416.
  • View/AxisZColor (unsigned): Idem for the Z axis elements. Defaults to 859032576.
  • View/NavigationDebug (boolean): Enables debug output of navigation styles (as of v0.19, only Gesture navigation style has something to say).
  • View/SavePicture (string): Set to FramebufferObject, PixelBuffer or CoinOffscreenRenderer for different methods to produce images from the 3D view.

Default export filename

  • General/ExportDefaultFilenameMultiple (string): Set the default filename to use when exporting multiple objects. Defaults to %F.
  • General/ExportDefaultFilenameSingle (string): Set the default filename to use when exporting a single object. Defaults to %F-%P-.

Both of these options support the automatic insertion of various pieces of information into the filename, using the following format characters:

  • %F - the name of the .FCStd file (or the label, if it is not saved yet)
  • %Lx - the label of the selected object(s), separated by character 'x'
  • %Px - the label of the selected object(s) and their first parent, separated by character 'x'
  • %U - the date and time, in UTC, ISO 8601
  • %D - the date and time, in local timezone, ISO 8601

Any other characters are treated literally. If the resulting filename is illegal it will be changed on saving, with illegal characters replaced by the underscore (_).

Mouse related

  • General/ComboBoxWheelEventFilter (boolean): Set to true so widgets do not catch mouse wheel event and prevent scrollable areas to be scrolled. Needs FreeCAD restart to be taken into account.
  • View/GestureMoveThreshold (integer): the distance (px) mouse cursor has to move to enter rotation or pan modes of Gesture navigation style. Defaults to 5.
  • View/GestureRollFwdCommand, View/GestureRollBackCommand (string): commands to be executed by mouse button roll gestures of Gesture navigation style.
  • View/GestureTapHoldTimeout (integer): sets for how long to wait (in milliseconds) to enter pan mode in Gesture navigation style. It can be helpful to increase it if dragging geometry in sketcher is difficult. Defaults to 700.

Keyboard shortcuts

Escape key

  • General/TasksKeyEsc (boolean): Create and set to false to disable the ESC key exiting the Task panel in all workbenches (that is if the task panel has focus).

Navigation Cube

See Navigation Cube.

Specific workbenches

BIM Workbench

  • Mod/BIM/DefaultPageScale (float): Default scaling for new TechDraw pages created from the BIM Workbench, in case the template doesn't contain any "Scale" or "Scaling" (case insensitive) editable text field.

CAM Workbench

Draft Workbench

  • Mod/Draft/DefaultAnnoDisplayMode (integer): Set to 1 to create Draft annotations (texts, dimensions and labels) with their ViewDisplay Mode set to Screen. Set to 0 for new annotations with this property set to World. Defaults to 0. introduced in version 0.22
  • Mod/Draft/GridHideInOtherWorkbenches (boolean): Set to false to keep the Draft grid when switching to workbenches other than Arch, BIM or Draft. Defaults to true. introduced in version 0.22
  • Mod/Draft/useSupport (boolean): Set to true to set the DataSupport property of Draft objects created on a face of an exiting base object to that base object. This was standard behavior before FreeCAD version 0.19. Note that this parameter may not be supported in future versions. Defaults to false.

Part Workbench

  • Mod/Part/ParametricRefine (boolean): Set to false so Part RefineShape creates an independent copy rather than a linked one. Defaults to true.

PartDesign Workbench

  • Mod/PartDesign/AdditiveHelixPreview (boolean): Set to true to ensure an additive helix that does not intersect the body is visible in the preview. Defaults to false.
  • Mod/PartDesign/SubtractiveHelixPreview (boolean): Set to true to ensure a subtractive helix that does not intersect the body is visible in the preview. Defaults to true.
  • Mod/PartDesign/SwitchToTask (boolean): Set to false to prevent the PartDesign Workbench from switching to the Task panel when starting. Defaults to true.
  • Mod/PartDesign/SwitchToWB (boolean): Set to false to prevent the PartDesign Workbench to be automatically called when a PartDesign Body is activated. Defaults to true.

Sketcher Workbench

  • Mod/Sketcher/RadiusDiameterConstraintDisplayAngleRandomness (float): Set an angle randomness on the above value. Value is the range of the random angle, centered on base angle. Defaults to 0.
  • Mod/Sketcher/RadiusDiameterConstraintDisplayBaseAngle (float): Set the angle (from horizontal) used to display radius/diameter constraints in Sketcher at creation time. Defaults to 15.
  • Mod/Sketcher/RoundRectangleSuggConstraints (boolean): Set to false to disable the addition of two extra construction points when creating a rounded rectangle. introduced in version 0.21

Constraint label colors

The label in Sketcher that displays the current status of the constraints (e.g. "Underconstrained," "Fully Constrained," etc.) is styleable on a per-state basis either using the Qt stylesheet, or via user preferences. User preferences take precedence if they have been set (in Mod/Sketcher/General):

  • EmptySketchMessageColor - Defaults to 50% opacity black
  • UnderconstrainedMessageColor - Defaults to black
  • MalformedConstraintMessageColor - Defaults to red
  • ConflictingConstraintMessageColor - Defaults to red
  • RedundantConstraintMessageColor - Defaults to orange red
  • PartiallyRedundantConstraintMessageColor - Defaults to royal blue
  • SolverFailedMessageColor - Defaults to red
  • FullyConstrainedMessageColor - Defaults to green

Start Workbench

  • Mod/Start/DefaultImportXXX (string): Where XXX is a lowercase file extension. For example DefaultImportifc for .IFC files. Allows to set a default import module to be used when clicking an icon on the start page, when several importers are available. For example, setting DefaultImportifc = ifc_import will use the NativeIFC importer if available. introduced in version 0.21
  • Mod/Start/TimeFormat (string): A time format string such as %m/%d/%Y %H:%M:%S used for the date in the tooltip that is shown when an item on the start page is hovered.

Help Module

  • Mod/Help/UseWebModule (boolean): Allows to force the use of the Web module to open MDI tabs. This can be useful to work around QWebEngine issues in some versions of Qt5. Defaults to false. introduced in version 0.22


User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Fine-tuning&oldid=1399863"