Fine-tuning
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
- Bitmaps/Theme/Name (string): Specify the name of the icon theme to override the system icon theme used by FreeCAD. Only used if Bitmaps/Theme/UseIconTheme is
True
. - Bitmaps/Theme/ThemeSearchPaths (boolean): Set to
False
so FreeCAD uses its included icons instead of the system icon theme on Linux. {{VersionMinus|0.21}}. For later versions use Bitmaps/Theme/UseIconTheme instead. - Bitmaps/Theme/UseIconTheme (boolean): Set to
True
to force Qt to use icons from the system\'s icon theme. The default isFalse
so FreeCAD will use its own icons. It does not affect other Qt icon theme mechanisms such as system dialogs, buttons and others. Those should always use the icons from the system theme. (v1.0) - 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 toTrue
. - Dialog/DontUseNativeDialog (boolean): File dialog setting. Set to
False
if you want to use the native File dialog when opening files or toTrue
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 toTrue
. - 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 toFalse
. - General/RecentIncludesImported (boolean): Set to
False
to exclude imported files from the Recent Files list. Defaults toTrue
. - General/ShowSplasherMessages (boolean): Set to
False
to skip showing messages on the splashscreen. This may reduce the FreeCAD startup time. Defaults toTrue
. - Macro/DuplicateFrom001 (boolean): Set to
True
to always begin searching for suggested duplicate macro filename with \@001 instead of current \@NNN, if applicable. Defaults toFalse
. - 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\". IfTrue
the next suggested filename is \"my_macro@006.FCMacro\". If set toFalse
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 toFalse
. - 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 toTrue
. - 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 toFalse
. 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 toTrue
. - PropertyView/AutoTransactionView (boolean): Set to
True
so changes of View tab properties are added to the undo stack (hence are undoable). Defaults toFalse
. - Selection/AutoShowSelectionView (boolean): Set to
True
to make the Selection View pane show automatically when selecting something. Defaults toFalse
. - Selection/singleClickFeatureSelect (boolean): Set to
False
to disable single click selection of a feature in PartDesign. Defaults toTrue
. - 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 toFalse
. - 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 here for information about the color value.
- View/AxisXColor (unsigned): Color for the X axis elements of the Std TransformManip gizmo. Defaults to {{Value|3425907456}}. See 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/LocalCoordinateSystemSize (float): Size of local coordinate systems. Defaults to {{Value|2.0}}.
- 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 {{Value|%F}}.
- General/ExportDefaultFilenameSingle (string): Set the default filename to use when exporting a single object. Defaults to {{Value|%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 {{Value|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 {{Value|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
- The CAM Workbench has two switches to enable experimental features documented on the CAM experimental page.
Draft Workbench
- Mod/Draft/DefaultAnnoDisplayMode (integer): Set to {{Value|1}} to create Draft annotations (wiki-test2.php?gitpage=texts, dimensions and labels) with their Display Mode set to {{Value|Screen}}. Set to {{Value|0}} for new annotations with this property set to {{Value|World}}. Defaults to {{Value|0}}. (v1.0)
- Mod/Draft/GridHideInOtherWorkbenches (boolean): Set to
False
to keep the Draft grid when switching to workbenches other than BIM or Draft. Defaults toTrue
. (v1.0) - Mod/Draft/useSupport (boolean): Set to
True
to set the 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 toFalse
.
Part Workbench
- Mod/Part/ParametricRefine (boolean): Set to
False
so Part RefineShape creates an independent copy rather than a linked one. Defaults toTrue
.
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 toFalse
. - Mod/PartDesign/DefaultDatumColor (unsigned): Diffuse color and transparency for PartDesign datums, PartDesign ShapeBinders and PartDesign SubShapeBinders. Defaults to {{Value|4292280473}}. See here for information about the color value.
- Mod/PartDesign/SubtractiveHelixPreview (boolean): Set to
True
to ensure a subtractive helix that does not intersect the body is visible in the preview. Defaults toTrue
. - Mod/PartDesign/SwitchToTask (boolean): Set to
False
to prevent the PartDesign Workbench from switching to the Task panel when starting. Defaults toTrue
. - Mod/PartDesign/SwitchToWB (boolean): Set to
False
to prevent the PartDesign Workbench to be automatically called when a PartDesign Body is activated. Defaults toTrue
.
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 {{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. (v0.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
The Start Workbench is no longer included after version 0.21.
- 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. (v0.21)
- 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.
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
. (v1.0)
⏵ documentation index > Developer Documentation > Fine-tuning
This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Fine-tuning.md