Preferences Editor: Difference between revisions
mNo edit summary |
(Navigation cube: Button color -> Color.) |
||
(213 intermediate revisions by 8 users not shown) | |||
Line 15: | Line 15: | ||
<!--T:1--> |
<!--T:1--> |
||
− | To start the '''Preferences editor''' select the {{MenuCommand|Edit → Preferences...}} option from the menu. On |
+ | To start the '''Preferences editor''' select the {{MenuCommand|Edit → Preferences...}} option from the menu. On macOS the {{MenuCommand|Preferences...}} option appears in the {{MenuCommand|FreeCAD}} menu instead (this is the default place for preferences on the Mac). |
<!--T:2--> |
<!--T:2--> |
||
− | FreeCAD uses a workbench concept, where each workbench is responsible for specific tasks and functions. A workbench can have its own preferences. These will only appear in the Preferences editor if the workbench has been loaded in the current FreeCAD session. |
+ | FreeCAD uses a workbench concept, where each workbench is responsible for specific tasks and functions. A workbench can have its own preferences. These will only appear in the Preferences editor, usually in a dedicated section, if the workbench has been loaded in the current FreeCAD session. Some workbenches add support for specific import and export formats. If there are any related preferences they will appear on one or more additional tabs in the [[#Import-Export|Import-Export]] section of the Preferences editor. |
+ | |||
+ | <!--T:315--> |
||
+ | To preserve resources, FreeCAD does not automatically load all available workbenches. See [[#Workbenches|Workbenches]] for more information. For a list of workbench related preferences see [[#Workbench_related_preferences|Workbench related preferences]]. |
||
<!--T:6--> |
<!--T:6--> |
||
− | If no workbench is loaded, |
+ | If no workbench is loaded, six sections appear in the Preferences editor: [[#General|General]], [[#Display|Display]], [[#Workbenches|Workbenches]], [[#Python|Python]], [[#Addon_Manager|Addon Manager]] and [[#Import-Export|Import-Export]]. Any workbenches that have been loaded, and have their own preferences, will appear below these. |
<!--T:105--> |
<!--T:105--> |
||
Line 29: | Line 32: | ||
Some advanced preferences can only be changed in the [[Std_DlgParameter|Parameter editor]]. The [[Fine-tuning|Fine-tuning]] page lists some of them. |
Some advanced preferences can only be changed in the [[Std_DlgParameter|Parameter editor]]. The [[Fine-tuning|Fine-tuning]] page lists some of them. |
||
− | ==General |
+ | ==General== <!--T:4--> |
<!--T:5--> |
<!--T:5--> |
||
− | This preferences section has |
+ | This preferences section has six standard tabs: General, Document, Selection, Cache, Notification Area and Report view. A seventh tab, Help, is added if the [https://github.com/FreeCAD/FreeCAD-Help Help Addon] is available. This addon can be installed via the [[Std_AddonMgr|Addon Manager]]. |
===General=== <!--T:13--> |
===General=== <!--T:13--> |
||
Line 44: | Line 47: | ||
!style="width: 66%;"|Description |
!style="width: 66%;"|Description |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Language}} |
− | | |
+ | | Specifies the language of the FreeCAD user interface. |
+ | |- |
||
+ | | {{MenuCommand|Unit system}} |
||
+ | | Specifies the unit system to be used for all parts of FreeCAD. |
||
+ | |- |
||
+ | | {{MenuCommand|Number of decimals}} |
||
+ | | The number of decimals that should be shown for numbers and dimensions. |
||
+ | |- |
||
+ | | {{MenuCommand|Number format}} {{Version|0.20}} |
||
+ | | Specifies the number format. The options are: |
||
+ | * '''Operating system''': The decimal separator defined by the operating system is used. |
||
+ | * '''Selected language''': The decimal separator of the selected FreeCAD interface language is used. |
||
+ | * '''C/POSIX''': A point is used as the decimal separator. |
||
|- |
|- |
||
| {{MenuCommand|Substitute decimal separator}} {{Version|0.20}} |
| {{MenuCommand|Substitute decimal separator}} {{Version|0.20}} |
||
− | | If checked, the numerical keypad decimal separator will be substituted with the |
+ | | If checked, the numerical keypad decimal separator will be substituted with the separator defined by the {{MenuCommand|Number format}} setting. {{Version|0.21}}: Notice that if this preference is enabled, using the numerical keypad decimal separator will always print a dot/period in the [[Python_console|Python console]] and the [[Std_DlgMacroExecute#Edit|Macro editor]]. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Style sheet}} |
+ | | Specifies a style sheet. Style sheets define how the user interface of FreeCAD looks. For technical details about style sheets see [[Interface_Customization#Themes|themes]]. |
||
− | | This lists the available [[Preference_Packs|preference packs]] and also allows you to save new packs. |
||
+ | |- |
||
+ | | {{MenuCommand|Size of toolbar icons}} |
||
+ | | Specifies the size of the toolbar icons. The options are: |
||
+ | * '''Small (16px)''' |
||
+ | * '''Medium (24px)''' |
||
+ | * '''Large (32px)''' |
||
+ | * '''Extra large (48px)''' |
||
+ | |- |
||
+ | | {{MenuCommand|Tree view mode}} |
||
+ | | Defines how the tree view is shown in the user interface (restart required). The options are: |
||
+ | * '''Combo View''': Combines the tree view and the property view into one panel. |
||
+ | * '''TreeView and PropertyView''': Splits the tree view and the property view into separate panels. |
||
+ | * '''Both''': Shows all three panels. |
||
|- |
|- |
||
| {{MenuCommand|Size of recent file list}} |
| {{MenuCommand|Size of recent file list}} |
||
− | | |
+ | | Specifies how many files should be listed in the recent files list. |
|- |
|- |
||
| {{MenuCommand|Enable tiled background}} |
| {{MenuCommand|Enable tiled background}} |
||
− | | |
+ | | If checked, the background of FreeCAD's main window will by default consist of tiles of this image: [[File:Background.png|64px]] |
<!--T:197--> |
<!--T:197--> |
||
Line 72: | Line 100: | ||
<!--T:201--> |
<!--T:201--> |
||
− | {{FileName|$HOME/Library/Preferences/FreeCAD}} (on |
+ | {{FileName|$HOME/Library/Preferences/FreeCAD}} (on macOS). |
<!--T:202--> |
<!--T:202--> |
||
− | Place a |
+ | Place a file named {{FileName|background.png}} in the {{FileName|Images}} folder, and uncheck/check this option to see the changed file. |
− | |- |
||
− | | {{MenuCommand|Style sheet}} |
||
− | | Selection of a style sheet. Style sheets define how the user interface of FreeCAD looks. For technical details about the style sheets, see [[Interface_Customization#Themes|themes]]. |
||
− | |- |
||
− | | {{MenuCommand|Size of toolbar icons}} |
||
− | | Selection of the size for the toolbar icons |
||
− | |- |
||
− | | {{MenuCommand|Tree view mode}} |
||
− | | Customization how the tree view is shown in the panel (restart required). The options are: |
||
− | * '''Combo View''': combine tree view and property view into one panel. |
||
− | * '''TreeView and PropertyView''': split tree view and property view into separate panel. |
||
− | * '''Both''': keep all three panels, and you can have two sets of tree view and property view. |
||
− | |- |
||
− | | {{MenuCommand|Auto load module after start up}} |
||
− | | Selection what workbench will be used directly after starting FreeCAD |
||
|- |
|- |
||
| {{MenuCommand|Enable splash screen at start up}} |
| {{MenuCommand|Enable splash screen at start up}} |
||
− | | |
+ | | If checked, a splash screen is shown when starting FreeCAD. |
<!--T:203--> |
<!--T:203--> |
||
The splash screen image can be changed by placing a file named {{FileName|splash_image.png}} in the {{FileName|Images}} folder already mentioned under {{MenuCommand|Enable tiled background}}. |
The splash screen image can be changed by placing a file named {{FileName|splash_image.png}} in the {{FileName|Images}} folder already mentioned under {{MenuCommand|Enable tiled background}}. |
||
|- |
|- |
||
− | | {{MenuCommand|Enable |
+ | | {{MenuCommand|Enable cursor blinking}} |
+ | | If checked the text cursor in the [[Python_console|Python console]] and the [[Std_DlgMacroExecute#Edit|Macro editor]] will blink. |
||
− | | Words will be wrapped when they exceed the available horizontal space in the Python console. This console is shown using the menu {{MenuCommand|View → Panels → Python console}}. |
||
+ | |- |
||
+ | | {{MenuCommand|Preference packs}} {{Version|0.20}} |
||
+ | | Lists the available [[Preference_Packs|preference packs]] and also allows you to import, save, manage and revert them. |
||
|} |
|} |
||
− | <!--T: |
+ | <!--T:299--> |
[[Image:Preferences_General_Tab_General.png]] |
[[Image:Preferences_General_Tab_General.png]] |
||
Line 116: | Line 132: | ||
|- |
|- |
||
| {{MenuCommand|Create new document at start up}} |
| {{MenuCommand|Create new document at start up}} |
||
− | | If checked, FreeCAD will create a new document when started |
+ | | If checked, FreeCAD will create a new document when started. |
|- |
|- |
||
| {{MenuCommand|Document save compression level}} |
| {{MenuCommand|Document save compression level}} |
||
− | | |
+ | | Specifies the compression level for {{FileName|FCStd}} files. {{FileName|FCStd}} files are ZIP-compressed files. Therefore you can rename their suffix {{FileName|.FCStd}} to {{FileName|.zip}} and open them with a ZIP archive program. |
|- |
|- |
||
| {{MenuCommand|Using Undo/Redo on documents}} |
| {{MenuCommand|Using Undo/Redo on documents}} |
||
− | | |
+ | | If checked, all changes in documents are stored so that they can be undone/redone. |
|- |
|- |
||
| {{MenuCommand|Maximum Undo/Redo steps}} |
| {{MenuCommand|Maximum Undo/Redo steps}} |
||
− | | |
+ | | Specifies how many Undo/Redo steps should be recorded. |
|- |
|- |
||
| {{MenuCommand|Allow aborting recomputation}} |
| {{MenuCommand|Allow aborting recomputation}} |
||
− | | |
+ | | If checked, recomputations can be aborted by pressing {{KEY|Esc}}. This may slightly increase the recomputation time. |
|- |
|- |
||
| {{MenuCommand|Run AutoRecovery at startup}} |
| {{MenuCommand|Run AutoRecovery at startup}} |
||
− | | |
+ | | If there is a recovery file available FreeCAD will automatically run a file recovery when it is started. This way files can be restored if a crash occurred. |
|- |
|- |
||
| {{MenuCommand|Save AutoRecovery information every}} |
| {{MenuCommand|Save AutoRecovery information every}} |
||
− | | |
+ | | Specifies how often a recovery file is written. |
|- |
|- |
||
| {{MenuCommand|Save thumbnail into project file when saving document}} |
| {{MenuCommand|Save thumbnail into project file when saving document}} |
||
− | | |
+ | | If checked, a thumbnail will be stored when the document is saved. The thumbnail will for example be shown in the list of recent files in the [[Start_Workbench|Start Workbench]]. It is possible to select a {{MenuCommand|Size}} between 128×128 and 512×512 pixels for the thumbnail. Common sizes are powers of two: 128, 256, 512. |
|- |
|- |
||
| {{MenuCommand|Add the program logo to the generated thumbnail}} |
| {{MenuCommand|Add the program logo to the generated thumbnail}} |
||
− | | |
+ | | If checked, the FreeCAD program logo [[image:Freecad.svg|24px]] will be added to the thumbnail. |
|- |
|- |
||
| {{MenuCommand|Maximum number of backup files to keep when resaving document}} |
| {{MenuCommand|Maximum number of backup files to keep when resaving document}} |
||
− | | |
+ | | If checked, backup files will be kept when saving the document. You can specify the number of backup files to keep. Backup files are previously saved versions of the document. The first backup file will have the file suffix {{FileName|.FCStd1}}, the second {{FileName|.FCStd2}} and so on. |
|- |
|- |
||
| {{MenuCommand|Use date and FCBak extension}} |
| {{MenuCommand|Use date and FCBak extension}} |
||
− | | |
+ | | If checked, backup files will get the extension {{FileName|.FCbak}} and their file names get a date suffix according to the specified {{MenuCommand|Date format}}. For a description of the date format see [https://devhints.io/datetime Date & time formats cheatsheet]. |
With the default settings a backup file will for example get this name {{FileName|TD-Cube.20200315-215654.FCBak}} (original filename is {{FileName|TD-Cube.FCStd}}). |
With the default settings a backup file will for example get this name {{FileName|TD-Cube.20200315-215654.FCBak}} (original filename is {{FileName|TD-Cube.FCStd}}). |
||
|- |
|- |
||
| {{MenuCommand|Allow duplicate object labels in one document}} |
| {{MenuCommand|Allow duplicate object labels in one document}} |
||
− | | |
+ | | If checked, objects can have the same label. |
|- |
|- |
||
| {{MenuCommand|Disable partial loading of external linked objects}} |
| {{MenuCommand|Disable partial loading of external linked objects}} |
||
− | | |
+ | | If partial loading of external linked objects is enabled, only the referenced objects and their dependencies will be loaded when the linked document is auto opened together with the main document. Such a partially loaded document cannot be edited. Double click the document icon in the tree view to reload it in full. A more detailed explanation of this feature can be found on the [https://github.com/realthunder/FreeCAD_assembly3/wiki/Core-Changes#partial-document-loading Assembly3 documentation page]. |
|- |
|- |
||
| {{MenuCommand|Author name}} |
| {{MenuCommand|Author name}} |
||
− | | |
+ | | All created documents will get the specified author name. Keep the author field blank if you do not want to include this information. If the option {{MenuCommand|Set on save}} is checked, the field '''Last modified by''' will be set to the specified author when saving the file. This field can be viewed using the {{MenuCommand|File → Project information}} menu option. |
|- |
|- |
||
| {{MenuCommand|Company}} |
| {{MenuCommand|Company}} |
||
− | | |
+ | | All created documents will get the specified company name. |
|- |
|- |
||
| {{MenuCommand|Default license}} |
| {{MenuCommand|Default license}} |
||
− | | |
+ | | Specifies the license for new documents. For predefined licenses the {{MenuCommand|License URL}} will automatically be set accordingly. Select '''Other''' for a custom license. |
|- |
|- |
||
| {{MenuCommand|License URL}} |
| {{MenuCommand|License URL}} |
||
− | | |
+ | | Specifies an URL describing the license selected in {{MenuCommand|Default license}}. |
|} |
|} |
||
− | <!--T: |
+ | <!--T:300--> |
[[Image:Preferences_General_Tab_Document.png]] |
[[Image:Preferences_General_Tab_Document.png]] |
||
Line 174: | Line 190: | ||
<!--T:229--> |
<!--T:229--> |
||
− | On the ''Selection'' tab |
+ | On the ''Selection'' tab you can specify the following: |
<!--T:238--> |
<!--T:238--> |
||
Line 182: | Line 198: | ||
|- |
|- |
||
| {{MenuCommand|Auto switch to the 3D view containing the selected item}} |
| {{MenuCommand|Auto switch to the 3D view containing the selected item}} |
||
− | | Enables the [[Std_TreeSyncView|Tree view SyncView mode]] |
+ | | Enables the [[Std_TreeSyncView|Tree view SyncView mode]]. |
|- |
|- |
||
| {{MenuCommand|Auto expand tree item when the corresponding object is selected in 3D view}} |
| {{MenuCommand|Auto expand tree item when the corresponding object is selected in 3D view}} |
||
− | | Enables the [[Std_TreeSyncSelection|Tree view SyncSelection mode]] |
+ | | Enables the [[Std_TreeSyncSelection|Tree view SyncSelection mode]]. |
|- |
|- |
||
| {{MenuCommand|Preselect the object in 3D view when mouse over the tree item}} |
| {{MenuCommand|Preselect the object in 3D view when mouse over the tree item}} |
||
− | | Enables the [[Std_TreePreSelection|Tree view PreSelection mode]] |
+ | | Enables the [[Std_TreePreSelection|Tree view PreSelection mode]]. |
|- |
|- |
||
| {{MenuCommand|Record selection in tree view in order to go back/forward using navigation button}} |
| {{MenuCommand|Record selection in tree view in order to go back/forward using navigation button}} |
||
− | | Enables the [[Std_TreeRecordSelection|Tree view RecordSelection mode]] |
+ | | Enables the [[Std_TreeRecordSelection|Tree view RecordSelection mode]]. |
|- |
|- |
||
| {{MenuCommand|Add checkboxes for selection in document tree}} |
| {{MenuCommand|Add checkboxes for selection in document tree}} |
||
− | | Each [[Tree_view| |
+ | | Each [[Tree_view|Tree view]] item will get a checkbox. This is for example useful for selecting multiple items on a touchscreen. |
|} |
|} |
||
− | <!--T: |
+ | <!--T:301--> |
[[Image:Preferences_General_Tab_Selection.png]] |
[[Image:Preferences_General_Tab_Selection.png]] |
||
− | ===Cache=== |
+ | ===Cache=== <!--T:270--> |
+ | <!--T:274--> |
||
+ | These preferences are related to the cache directory where FreeCAD stores temporary files. |
||
+ | |||
+ | <!--T:271--> |
||
On the ''Cache'' tab ({{Version|0.20}}) you can specify the following: |
On the ''Cache'' tab ({{Version|0.20}}) you can specify the following: |
||
+ | <!--T:272--> |
||
{| class="wikitable float-right mw-collapsible mw-collapsed" |
{| class="wikitable float-right mw-collapsible mw-collapsed" |
||
!style="width: 33%;"|Name |
!style="width: 33%;"|Name |
||
Line 209: | Line 230: | ||
|- |
|- |
||
| {{MenuCommand|Location}} |
| {{MenuCommand|Location}} |
||
+ | | Specifies the path of the cache directory. |
||
− | | ?? |
||
|- |
|- |
||
| {{MenuCommand|Check periodically at program start}} |
| {{MenuCommand|Check periodically at program start}} |
||
+ | | Controls the frequency with which the directory size is checked. The options are: |
||
− | | ?? |
||
+ | * '''Always''' |
||
+ | * '''Daily''' |
||
+ | * '''Weekly''' |
||
+ | * '''Monthly''' |
||
+ | * '''Yearly''' |
||
+ | * '''Never''' |
||
|- |
|- |
||
| {{MenuCommand|Cache size limit}} |
| {{MenuCommand|Cache size limit}} |
||
+ | | Specifies the maximum size of the directory. You will be notified if a check is performed and the size exceeds this value. The options are: |
||
− | | ?? |
||
+ | * '''100 MB''' |
||
+ | * '''300 MB''' |
||
+ | * '''500 MB''' |
||
+ | * '''1 GB''' |
||
+ | * '''2 GB''' |
||
+ | * '''3 GB''' |
||
|- |
|- |
||
| {{MenuCommand|Current cache size}} |
| {{MenuCommand|Current cache size}} |
||
+ | | Shows the current size of the directory, if available. Press the {{Button|Check now...}} button to update the value. |
||
− | | ?? |
||
|} |
|} |
||
+ | <!--T:302--> |
||
[[Image:Preferences_General_Tab_Cache.png]] |
[[Image:Preferences_General_Tab_Cache.png]] |
||
− | === |
+ | ===Notification Area=== <!--T:319--> |
− | <!--T: |
+ | <!--T:320--> |
+ | These preferences control the Notification Area and its notifications. |
||
− | The editor preferences settings affect the behavior of the macro editor. This editor can be opened using the menu {{MenuCommand|Macro → Macros... → Edit/Create}}. |
||
− | <!--T: |
+ | <!--T:321--> |
+ | On the ''Notification Area'' tab ({{Version|0.21}}) you can specify the following: |
||
− | The color and font settings also affect the [[Python console|Python console]]. This console is shown using the menu {{MenuCommand|View → Panels → Python console}}. |
||
− | <!--T: |
+ | <!--T:322--> |
− | On the ''Editor'' tab you can specify the following: |
||
− | |||
− | <!--T:239--> |
||
{| class="wikitable float-right mw-collapsible mw-collapsed" |
{| class="wikitable float-right mw-collapsible mw-collapsed" |
||
!style="width: 33%;"|Name |
!style="width: 33%;"|Name |
||
!style="width: 66%;"|Description |
!style="width: 66%;"|Description |
||
|- |
|- |
||
− | | {{MenuCommand|Enable |
+ | | {{MenuCommand|Enable Notification Area}} |
− | | |
+ | | If checked, the Notification Area will appear in the status bar. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Enable non-intrusive notifications}} |
+ | | If checked, non-intrusive notifications will appear next to the Notification Area in the status bar. |
||
− | | Specification of the tabulator raster (how many spaces). If it is for example set to '''6''', pressing {{KEY|Tab}} will jump to character 7 or 13 or 19 etc., depending on the current cursor position. This setting is only used if {{MenuCommand|Keep tabs}} is selected. |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Errors}} |
+ | | If checked, errors will appear in the Notification Area. |
||
− | | Specification of how many spaces will be inserted when pressing {{KEY|Tab}}. This setting is only used if {{MenuCommand|Insert spaces}} is selected. |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Warnings}} |
+ | | If checked, warnings will appear in the Notification Area. |
||
− | | If selected, pressing {{KEY|Tab}} will insert a tabulator with the raster defined by {{MenuCommand|Tab size}} |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Maximum Duration}} |
+ | | Maximum duration during which notifications are shown (unless mouse buttons are clicked). |
||
− | | If selected, pressing {{KEY|Tab}} will insert the amount of spaces defined by {{MenuCommand|Indent size}} |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Minimum Duration}} |
+ | | Minimum duration (idem). |
||
− | | Selection of the code type. The color and font settings will be applied to the selected type. The result can be checked in the '''Preview''' field. |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Maximum Number of Notifications}} |
+ | | Maximum number of notifications shown simultaneously. |
||
− | | Specification of the font family that should be used for the selected code type |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Notification width}} |
+ | | Width of the Notification Area in pixels. |
||
− | | Specification of the font size that should be used for the selected code type |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Hide when other window is activated}} |
+ | | If checked, open notifications will disappear when another window is activated. |
||
− | | Specification of the color that should be used for the selected code type |
||
+ | |- |
||
+ | | {{MenuCommand|Do not show when inactive}} |
||
+ | | If checked, notifications will not appear if the FreeCAD window is not the active window. |
||
+ | |- |
||
+ | | {{MenuCommand|Maximum Messages (0 = no limit)}} |
||
+ | | The maximum number of messages kept in the list. Set to 0 for no limit. |
||
+ | |- |
||
+ | | {{MenuCommand|Auto-remove User Notifications}} |
||
+ | | If checked, notifications will be removed from the message list when the '''Maximum Duration''' has elapsed. |
||
|} |
|} |
||
− | <!--T: |
+ | <!--T:323--> |
− | [[Image: |
+ | [[Image:Preferences_General_Tab_Notification_Area.png]] |
− | === |
+ | ===Report view=== <!--T:324--> |
<!--T:135--> |
<!--T:135--> |
||
− | + | These preferences control the behavior of the [[Report_view|Report view]]. This panel can be opened using the {{MenuCommand|View → Panels → Report view}} menu option. |
|
<!--T:205--> |
<!--T:205--> |
||
− | On the '' |
+ | On the ''Report view'' tab you can specify the following: |
<!--T:240--> |
<!--T:240--> |
||
Line 284: | Line 324: | ||
|- |
|- |
||
| {{MenuCommand|Record normal messages}} |
| {{MenuCommand|Record normal messages}} |
||
− | | If checked, normal messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Normal messages}}. |
+ | | If checked, normal messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Normal messages}}. |
|- |
|- |
||
| {{MenuCommand|Record log messages}} |
| {{MenuCommand|Record log messages}} |
||
− | | If checked, log messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Log messages}}. |
+ | | If checked, log messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Log messages}}. |
|- |
|- |
||
| {{MenuCommand|Record warnings}} |
| {{MenuCommand|Record warnings}} |
||
− | | |
+ | | If checked, warnings will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Warnings}}. |
|- |
|- |
||
| {{MenuCommand|Record error messages}} |
| {{MenuCommand|Record error messages}} |
||
− | | |
+ | | If checked, error messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Errors}}. |
|- |
|- |
||
| {{MenuCommand|Show report view on error}} |
| {{MenuCommand|Show report view on error}} |
||
− | | |
+ | | If checked, the [[Report_view|Report view]] will be shown automatically when an error is recorded. |
|- |
|- |
||
| {{MenuCommand|Show report view on warning}} |
| {{MenuCommand|Show report view on warning}} |
||
− | | |
+ | | If checked, the [[Report_view|Report view]] will be shown automatically when a warning is recorded. |
|- |
|- |
||
| {{MenuCommand|Show report view on normal message}} |
| {{MenuCommand|Show report view on normal message}} |
||
− | | |
+ | | If checked, the [[Report_view|Report view]] will be shown automatically when a normal message is recorded. |
|- |
|- |
||
| {{MenuCommand|Show report view on log message}} |
| {{MenuCommand|Show report view on log message}} |
||
− | | |
+ | | If checked, the [[Report_view|Report view]] will be shown automatically when a log message is recorded. |
|- |
|- |
||
| {{MenuCommand|Include a timecode for each entry}} |
| {{MenuCommand|Include a timecode for each entry}} |
||
− | | |
+ | | If checked, each message and warning will receive a timecode. |
|- |
|- |
||
| {{MenuCommand|Normal messages}} |
| {{MenuCommand|Normal messages}} |
||
− | | |
+ | | Specifies the font color for normal messages. |
|- |
|- |
||
| {{MenuCommand|Log messages}} |
| {{MenuCommand|Log messages}} |
||
− | | |
+ | | Specifies the font color for log messages. |
|- |
|- |
||
| {{MenuCommand|Warnings}} |
| {{MenuCommand|Warnings}} |
||
− | | |
+ | | Specifies the font color for warning messages. |
|- |
|- |
||
| {{MenuCommand|Errors}} |
| {{MenuCommand|Errors}} |
||
− | | |
+ | | Specifies the font color for error messages. |
<!--T:241--> |
<!--T:241--> |
||
|- |
|- |
||
| {{MenuCommand|Redirect internal Python output to report view}} |
| {{MenuCommand|Redirect internal Python output to report view}} |
||
− | | |
+ | | If checked, internal Python output will be redirected from the [[Python_console|Python console]] to the [[Report_view|Report view]]. |
|- |
|- |
||
| {{MenuCommand|Redirect internal Python errors to report view}} |
| {{MenuCommand|Redirect internal Python errors to report view}} |
||
− | | |
+ | | If checked, internal Python error messages will be redirected from the [[Python_console|Python console]] to the [[Report_view|Report view]]. |
|} |
|} |
||
− | <!--T: |
+ | <!--T:305--> |
− | [[Image: |
+ | [[Image:Preferences_General_Tab_Report_view.png]] |
− | === |
+ | ===Help=== <!--T:288--> |
− | <!--T: |
+ | <!--T:289--> |
+ | This tab is only available if the [https://github.com/FreeCAD/FreeCAD-Help Help Addon] has been [[Std AddonMgr|installed]]. |
||
− | On the ''Macro'' tab you can specify the following: |
||
− | <!--T: |
+ | <!--T:290--> |
+ | On the ''Help'' tab you can specify the following: |
||
− | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
− | !style="width: 33%;"|Name |
||
− | !style="width: 66%;"|Description |
||
− | |- |
||
− | | {{MenuCommand|Run macros in local environment}} |
||
− | | If checked, variables defined by macros are created as local variables, otherwise as global Python variables |
||
− | |- |
||
− | | {{MenuCommand|Macro path}} |
||
− | | Specification of the path for macro files |
||
− | |- |
||
− | | {{MenuCommand|Record GUI commands}} |
||
− | | If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands |
||
− | |- |
||
− | | {{MenuCommand|Record as comment}} |
||
− | | If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands, but as comments. This is useful if you don't want to execute these commands when running the macro, but do want to see what has been done while recording. |
||
− | |- |
||
− | | {{MenuCommand|Show script commands in python console}} |
||
− | | If checked, the commands executed by macro scripts are shown in the Python console. This console is shown using the {{MenuCommand|View → Panels → Python console}} menu option. |
||
− | |- |
||
− | | {{MenuCommand|Size of recent macros list}} |
||
− | | Controls the number of recent macros to display in the menu |
||
− | |- |
||
− | | {{MenuCommand|Shortcut count}} |
||
− | | Controls the number of recent macros that get dynamically assigned shortcuts |
||
− | |- |
||
− | | {{MenuCommand|Keyboard Modifiers}} |
||
− | | Controls which keyboard modifiers are used for the shortcuts, example '''Ctrl+Shift+''' creates shortcuts in the form of '''Ctrl+Shift+1''', '''Ctrl+Shift+2''', etc. |
||
− | |} |
||
− | <!--T: |
+ | <!--T:291--> |
− | [[Image:Preferences_General_Tab_Macro.png]] |
||
− | |||
− | ===Units=== <!--T:23--> |
||
− | |||
− | <!--T:106--> |
||
− | On the ''Units'' tab you can specify the following: |
||
− | |||
− | <!--T:243--> |
||
{| class="wikitable float-right mw-collapsible mw-collapsed" |
{| class="wikitable float-right mw-collapsible mw-collapsed" |
||
!style="width: 33%;"|Name |
!style="width: 33%;"|Name |
||
!style="width: 66%;"|Description |
!style="width: 66%;"|Description |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Help location}} |
+ | | Specifies the location of the Help files. The options are: |
||
− | | Selection of the unit system to be used for all parts of FreeCAD |
||
+ | * {{MenuCommand|Online}}: Enter the URL or leave blank to use the automatic [https://github.com/FreeCAD/FreeCAD-documentation/tree/main/wiki GitHub URL]. |
||
+ | : {{MenuCommand|Translation suffix}}: If {{Value|https://wiki.freecad.org/}} is used, a [https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes language suffix] can be specified. Use for example {{Value|fr}} for the French translation. Must be blank for the GitHub URL. |
||
+ | * {{MenuCommand|From disk location}}: Enter the path where the downloaded FreeCAD documentation can be found. To download the documentation select the ''offline-documentation'' addon from the Workbenches list in the [[Std_AddonMgr|Addon Manager]]. |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Display}} |
− | | |
+ | | Specifies where the documentation should be displayed. The options are: |
+ | * {{MenuCommand|In a new FreeCAD tab}}: The documentation is displayed on a new tab in the [[Main_view_area|Main view area]]. |
||
+ | * {{MenuCommand|In your default web browser}}: The documentation is displayed in the default web browser. |
||
+ | * {{MenuCommand|In a separate, embeddable, dialog}}: The documentation is displayed in a separate dialog. This dialog can be docked on top of the [[Combo_view|Combo view]] for example. |
||
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Custom stylesheet}} |
+ | | Specifies an optional custom stylesheet. Not used for the Wiki URL. |
||
− | | Minimum fractional inch that should be displayed. This setting is only available if the unit system '''Building US (ft-in/sqft/cuft)''' is used. |
||
|} |
|} |
||
− | <!--T: |
+ | <!--T:308--> |
− | [[Image: |
+ | [[Image:Preferences_General_Tab_Help.png]] |
− | ==Display |
+ | ==Display== <!--T:25--> |
<!--T:107--> |
<!--T:107--> |
||
Line 411: | Line 422: | ||
|- |
|- |
||
| {{MenuCommand|Show coordinate system in the corner}} |
| {{MenuCommand|Show coordinate system in the corner}} |
||
− | | If checked, the main coordinate system will |
+ | | If checked, the main coordinate system will be shown in the lower right corner of the [[3D_view|3D view]]. |
− | The {{MenuCommand|Relative size}} {{Version|0.20}} defines the size of the representation as a percentage of the |
+ | The {{MenuCommand|Relative size}} ({{Version|0.20}}) defines the size of the representation as a percentage of the view size (the minimum of its height and width). |
|- |
|- |
||
− | | {{MenuCommand|Show axis cross by default |
+ | | {{MenuCommand|Show axis cross by default}} |
− | | If checked, the axis cross will be shown by default |
+ | | If checked, the axis cross will be shown by default in the [[3D_view|3D view]]. |
|- |
|- |
||
| {{MenuCommand|Show counter of frames per second}} |
| {{MenuCommand|Show counter of frames per second}} |
||
− | | |
+ | | If checked, the time needed for the last operation and the resulting [https://en.wikipedia.org/wiki/Frame_rate frame rate] will be shown in the lower left corner of the [[3D_view|3D view]]. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Use software OpenGL}} |
− | | If checked, the application will remember the active workbench for each tab in the [[Main_view_area|Main view area]] independently. When switching to a tab this workbench will be restored automatically. |
||
− | |- |
||
− | | {{MenuCommand|Use software OpenGL}} {{Version|0.19}} |
||
| If checked, [https://en.wikipedia.org/wiki/OpenGL OpenGL] will use the CPU instead of the GPU. This option is useful for troubleshooting graphics card and driver problems. Changing this option requires a restart of the application. |
| If checked, [https://en.wikipedia.org/wiki/OpenGL OpenGL] will use the CPU instead of the GPU. This option is useful for troubleshooting graphics card and driver problems. Changing this option requires a restart of the application. |
||
|- |
|- |
||
| {{MenuCommand|Use OpenGL VBO (Vertex Buffer Object)}} |
| {{MenuCommand|Use OpenGL VBO (Vertex Buffer Object)}} |
||
− | | |
+ | | If checked, [https://en.wikipedia.org/wiki/Vertex_Buffer_Object Vertex Buffer Objects] (VBO) will be used. A VBO is an [https://en.wikipedia.org/wiki/OpenGL OpenGL] feature that provides methods for uploading vertex data (position, normal vector, color, etc.) to the graphics card. VBOs offer substantial performance gains because the data resides in the graphics memory rather than the system memory and so it can be rendered directly by the GPU. For more background info see [https://www.haroldserrano.com/blog/understanding-opengl-objects Understanding OpenGL Objects]. |
|- |
|- |
||
− | | {{MenuCommand|Render Cache |
+ | | {{MenuCommand|Render Cache}} |
− | | |
+ | | "Render Cache" or "Render Acceleration" is explained in more detail in [https://github.com/realthunder/FreeCAD_assembly3/wiki/Link#render-caching FreeCAD assembly3 render-caching]. The options are: |
− | * '''Auto''' |
+ | * '''Auto''': Let Coin3D decide where to cache (default). |
− | * '''Distributed''' |
+ | * '''Distributed''': Manually turn on cache for all view provider root nodes. |
− | * '''Centralized''' |
+ | * '''Centralized''': Manually turn off cache in all nodes of all view providers, and only cache at the scene graph root node. This offers the fastest rendering speed, but slower response to any scene changes. |
|- |
|- |
||
| {{MenuCommand|Anti-Aliasing}} |
| {{MenuCommand|Anti-Aliasing}} |
||
− | | |
+ | | Specifies if and what type of [https://en.wikipedia.org/wiki/Multisample_anti-aliasing multisample anti-aliasing] is used |
|- |
|- |
||
− | | {{MenuCommand|Transparent objects |
+ | | {{MenuCommand|Transparent objects}} |
− | | |
+ | | Specifies the render type of transparent objects. The options are: |
− | * '''One pass''' |
+ | * '''One pass''': Rendering is done in one pass (default). This can lead to triangular artifacts. If these occur the type '''Backface pass''' can be used to avoid them. |
− | * '''Backface pass''' |
+ | * '''Backface pass''': Rendering is done in two passes. Back-facing polygons are rendered in the first pass and front-facing polygons in the second pass. |
|- |
|- |
||
| {{MenuCommand|Marker size}} |
| {{MenuCommand|Marker size}} |
||
− | | |
+ | | Specifies the size of [[Glossary#Vertex|vertices]] (points) in the [[Sketcher_Workbench|Sketcher Workbench]]. The clickable area of points can be additionally enlarged by increasing the {{MenuCommand|Pick radius}}. |
|- |
|- |
||
| {{MenuCommand|Pick radius (px)}} |
| {{MenuCommand|Pick radius (px)}} |
||
− | | |
+ | | Sets the area for picking elements in the [[3D_view|3D view]]. Larger value makes it easier to pick things, but can make some small features impossible to select. |
|- |
|- |
||
| {{MenuCommand|Eye to eye distance for stereo modes}} |
| {{MenuCommand|Eye to eye distance for stereo modes}} |
||
− | | |
+ | | Specifies the eye-to-eye distance used for stereo projections. The specified value is a factor that will be multiplied with the [[Property_editor#View|bounding box]] size of the 3D object that is currently displayed. |
|- |
|- |
||
| {{MenuCommand|Backlight color}} |
| {{MenuCommand|Backlight color}} |
||
− | | |
+ | | If checked, backlight is enabled with the defined color. Backlight is used for rendering the back sides of faces. Usually, you don't see them in solids, unless you slice one with a clipping plane, or if the faces aren't oriented correctly. It is only used for objects whose Lighting property (on the View tab) is set to '''One side'''. If disabled, the back side of the faces of those objects will be black. |
The related {{MenuCommand|Intensity}} setting specifies the intensity of the backlight. |
The related {{MenuCommand|Intensity}} setting specifies the intensity of the backlight. |
||
|- |
|- |
||
| {{MenuCommand|Camera type}} |
| {{MenuCommand|Camera type}} |
||
− | | |
+ | | Specifies the camera projection type. The options are: |
+ | * '''Perspective rendering''': Objects will appear in a [https://en.wikipedia.org/wiki/Perspective_projection perspective projection]. |
||
− | |||
+ | * '''Orthographic rendering''': Objects will be appear in an [https://en.wikipedia.org/wiki/Orthographic_projection orthographic projection]. |
||
− | <!--T:208--> |
||
− | * '''Perspective rendering''', objects will appear in a [https://en.wikipedia.org/wiki/Perspective_projection perspective projection]. |
||
− | * '''Orthographic rendering''', objects will be projected in [https://en.wikipedia.org/wiki/Orthographic_projection orthographic projection]. |
||
|} |
|} |
||
− | <!--T: |
+ | <!--T:309--> |
[[Image:Preferences_Display_Tab_3D_View.png]] |
[[Image:Preferences_Display_Tab_3D_View.png]] |
||
− | ===Navigation=== <!--T:218--> |
+ | ===Navigation=== <!--T:218--> |
<!--T:220--> |
<!--T:220--> |
||
Line 478: | Line 484: | ||
|- |
|- |
||
| {{MenuCommand|Navigation cube}} |
| {{MenuCommand|Navigation cube}} |
||
− | | |
+ | | If checked, the [[Navigation_Cube|Navigation cube]] will be shown in the [[3D_view|3D view]]. |
<!--T:250--> |
<!--T:250--> |
||
{{MenuCommand|Steps by turn}} defines the number of steps required for a full rotation when using the Navigation cube rotation arrows. |
{{MenuCommand|Steps by turn}} defines the number of steps required for a full rotation when using the Navigation cube rotation arrows. |
||
− | |||
− | <!--T:251--> |
||
− | {{MenuCommand|Corner}} defines where the Navigation cube is displayed on the screen when creating or opening a document. |
||
<!--T:252--> |
<!--T:252--> |
||
− | If {{MenuCommand|Rotate to nearest}} is checked, the 3D view is rotated to the nearest most logical |
+ | If {{MenuCommand|Rotate to nearest}} is checked, the 3D view is rotated to the nearest most logical position, based on the current orientation of the cube, when a cube face is clicked. Else clicking a face will always result in the same rotation. {{Version|0.20}} |
<!--T:253--> |
<!--T:253--> |
||
{{MenuCommand|Cube size}} defines the size of the cube. {{Version|0.20}} |
{{MenuCommand|Cube size}} defines the size of the cube. {{Version|0.20}} |
||
+ | |||
+ | <!--T:325--> |
||
+ | {{MenuCommand|Color}} sets the base color for all elements. {{Version|0.21}} |
||
+ | |||
+ | <!--T:251--> |
||
+ | {{MenuCommand|Corner}} defines where the Navigation cube is displayed in the [[3D_view|3D view]]. The options are: |
||
+ | * '''Top left''' |
||
+ | * '''Top right''' |
||
+ | * '''Bottom left''' |
||
+ | * '''Bottom right''' |
||
+ | |||
+ | <!--T:296--> |
||
+ | {{MenuCommand|Font name}} specifies the font used for the cube's texts. {{Version|0.21}} |
||
+ | |||
+ | <!--T:297--> |
||
+ | {{MenuCommand|Font size}} sets the size of the font used for the cube's texts. {{Version|0.21}} |
||
+ | |||
+ | <!--T:298--> |
||
|- |
|- |
||
| {{MenuCommand|3D Navigation}} |
| {{MenuCommand|3D Navigation}} |
||
− | | |
+ | | Specifies a [[Mouse_navigation|mouse navigation style]]. To see the details of each style, select it and then press the {{Button|Mouse...}} button. |
|- |
|- |
||
| {{MenuCommand|Orbit style}} |
| {{MenuCommand|Orbit style}} |
||
+ | | Specifies the rotation orbit style used when in rotation mode. The options are: |
||
− | | Selection of the rotation orbit style. When viewing a part in the x-y plane and being in the rotation mode of the 3D navigation, the difference is: If '''Trackball''' is selected, moving the mouse horizontally will rotate the part around the y-axis, if '''Turntable''' is selected the part will be rotated around the z-axis. |
||
+ | * '''Turntable''': Moving the mouse will divide the rotation in steps, rotations around the different axes are performed sequentially. |
||
+ | * '''Trackball''': Rotations around the different axes are performed simultaneously. |
||
+ | * '''Free Turntable''': Like '''Trackball''', but if possible the rotation axis is kept collinear with the global 3D view axis. {{Version|0.21}} |
||
|- |
|- |
||
| {{MenuCommand|Rotation mode}} |
| {{MenuCommand|Rotation mode}} |
||
− | | |
+ | | Defines the rotation center. The options are: |
+ | * '''Window center''' |
||
+ | * '''Drag at cursor''' |
||
+ | * '''Object center''' |
||
|- |
|- |
||
| {{MenuCommand|Default camera orientation}} |
| {{MenuCommand|Default camera orientation}} |
||
− | | |
+ | | Specifies the camera orientation for new documents. This setting is also used by the [[Std_ViewHome|Std ViewHome]] command. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Camera zoom}} |
− | | |
+ | | Affects the initial camera zoom level for new documents. The value you set is the diameter of a sphere that fits in [[3D_view|3D view]]. The default is 100 mm. It also sets the initial size of origin features (base planes in new [[PartDesign_Body|PartDesign Bodies]] and [[Std_Part|Std Parts]]). |
|- |
|- |
||
| {{MenuCommand|Enable animation}} |
| {{MenuCommand|Enable animation}} |
||
− | | |
+ | | If checked, and {{MenuCommand|3D Navigation}} is set to '''CAD''', rotations can be animated. If the mouse is moved while the scroll wheel and the right mouse button are pressed, the view is rotated. If one keeps the mouse moving while releasing the right mouse button, the rotation will continue. To end this animation left-click with the mouse. |
|- |
|- |
||
| {{MenuCommand|Zoom at cursor}} |
| {{MenuCommand|Zoom at cursor}} |
||
− | | |
+ | | If checked, zoom operations will be performed at the position of the mouse pointer. Otherwise zoom operations will be performed at the center of the current view. The {{MenuCommand|Zoom step}} defines how much will be zoomed. A zoom step of '''1''' means a factor of 7.5 for every zoom step. |
|- |
|- |
||
| {{MenuCommand|Invert zoom}} |
| {{MenuCommand|Invert zoom}} |
||
− | | |
+ | | If checked, the direction of zoom operations will be inverted. |
|- |
|- |
||
| {{MenuCommand|Disable touchscreen tilt gesture}} |
| {{MenuCommand|Disable touchscreen tilt gesture}} |
||
− | | |
+ | | If checked, and {{MenuCommand|3D Navigation}} is set to '''Gesture''', the tilting gesture will be disabled for pinch-zooming (two-finger zooming). |
|} |
|} |
||
− | <!--T: |
+ | <!--T:310--> |
[[Image:Preferences_Display_Tab_Navigation.png]] |
[[Image:Preferences_Display_Tab_Navigation.png]] |
||
Line 534: | Line 561: | ||
|- |
|- |
||
| {{MenuCommand|Enable preselection highlighting}} |
| {{MenuCommand|Enable preselection highlighting}} |
||
− | | If checked, preselection is turned on and the specified color will be used for it. Preselection means that for example edges |
+ | | If checked, preselection is turned on and the specified color will be used for it. Preselection means that for example edges of objects will be highlighted while hovering over them with the mouse to indicate they can be selected. |
|- |
|- |
||
| {{MenuCommand|Enable selection highlighting}} |
| {{MenuCommand|Enable selection highlighting}} |
||
− | | |
+ | | If checked, selection highlighting is turned on and the specified color will be used for it. |
|- |
|- |
||
| {{MenuCommand|Simple color}} |
| {{MenuCommand|Simple color}} |
||
− | | |
+ | | If selected, the background of the [[3D_view|3D view]] will have the specified color. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Linear gradient}} |
− | | |
+ | | If selected, the background of the [[3D_view|3D view]] will have a vertical color gradient defined by the specified '''Top''' and '''Bottom''' colors. if enabled, a '''Middle''' color can also be specified. Press the {{Button|[[Image:Button_sort.svg|16px]]}} button ({{Version|0.21}}) to switch the top and bottom colors. |
|- |
|- |
||
− | | {{MenuCommand| |
+ | | {{MenuCommand|Radial gradient}} {{Version|0.21}} |
+ | | If selected, the background of the [[3D_view|3D view]] will have a radial color gradient defined by the specified '''Central''' and '''End''' colors. if enabled, a '''Midway''' color can also be specified. Press the {{Button|[[Image:Button_sort.svg|16px]]}} button to switch the central and end colors. |
||
− | | Is only enabled if {{MenuCommand|Color gradient}} is selected. If checked, the color gradient will get the selected color as the middle color. |
||
|- |
|- |
||
| {{MenuCommand|Object being edited}} |
| {{MenuCommand|Object being edited}} |
||
− | | |
+ | | Specifies the background color for objects in the tree view that are currently edited. |
|- |
|- |
||
| {{MenuCommand|Active container}} |
| {{MenuCommand|Active container}} |
||
− | | |
+ | | Specifies the background color for active containers in the tree view. For example an [[PartDesign_Body#Active_Status|active PartDesign Body]] will get this color. |
|} |
|} |
||
− | <!--T: |
+ | <!--T:311--> |
[[Image:Preferences_Display_Tab_Colors.png]] |
[[Image:Preferences_Display_Tab_Colors.png]] |
||
Line 572: | Line 599: | ||
|- |
|- |
||
| {{MenuCommand|Default mesh color}} |
| {{MenuCommand|Default mesh color}} |
||
− | | |
+ | | Specifies the default face color. |
|- |
|- |
||
| {{MenuCommand|Default line color}} |
| {{MenuCommand|Default line color}} |
||
− | | |
+ | | Specifies the default line color. |
|- |
|- |
||
| {{MenuCommand|Mesh transparency}} |
| {{MenuCommand|Mesh transparency}} |
||
− | | |
+ | | Specifies the default mesh transparency. |
|- |
|- |
||
| {{MenuCommand|Line transparency}} |
| {{MenuCommand|Line transparency}} |
||
− | | |
+ | | Specifies the default line transparency. |
|- |
|- |
||
| {{MenuCommand|Two-side rendering}} |
| {{MenuCommand|Two-side rendering}} |
||
− | | |
+ | | If checked, the default value for the {{PropertyView|Lighting}} property is {{value|Two side}} instead of {{value|One side}}. {{value|Two side}} means the color of the interior side of faces is the same as the color of the exterior side. {{value|One side}} means their color is either the [[#3D_View|backlight color]], if enabled, or black. |
|- |
|- |
||
| {{MenuCommand|Show bounding-box for highlighted or selected meshes}} |
| {{MenuCommand|Show bounding-box for highlighted or selected meshes}} |
||
− | | |
+ | | If checked, the default value for the {{PropertyView|Selection Style}} property is {{value|BoundBox}} instead of {{value|Shape}}. {{value|BoundBox}} means a highlighted bounding box is displayed if meshes are highlighted or selected. {{value|Shape}} means the shape itself is then highlighted. |
|- |
|- |
||
| {{MenuCommand|Define normal per vertex}} |
| {{MenuCommand|Define normal per vertex}} |
||
− | | |
+ | | If checked, [https://en.wikipedia.org/wiki/Phong_shading Phong shading] is used, otherwise flat shading. Shading defines the appearance of surfaces. With flat shading the surface normals are not defined per vertex. This leads to an unrealistic appearance for curved surfaces. While Phong shading leads to a more realistic, smoother appearance. |
|- |
|- |
||
| {{MenuCommand|Crease angle}} |
| {{MenuCommand|Crease angle}} |
||
− | | |
+ | | The crease angle is a threshold angle between two faces. It can only be set if the option {{MenuCommand|Define normal per vertex}} is used. |
− | :If face angle ≥ crease angle, facet shading is used |
+ | :If face angle ≥ crease angle, facet shading is used. |
− | :If face angle < crease angle, smooth shading |
+ | :If face angle < crease angle, smooth shading is used. |
|} |
|} |
||
− | <!--T: |
+ | <!--T:312--> |
[[Image:Preferences_Display_Tab_Mesh_view.png]] |
[[Image:Preferences_Display_Tab_Mesh_view.png]] |
||
Line 608: | Line 635: | ||
===Available Workbenches=== <!--T:249--> |
===Available Workbenches=== <!--T:249--> |
||
− | <!--T: |
+ | <!--T:316--> |
+ | These preferences control workbench loading. |
||
− | To preserve resources, FreeCAD does not automatically load all available workbenches. And only if a workbench has been loaded will its preferences, if any, appear in the Preferences editor. |
||
− | <!--T: |
+ | <!--T:317--> |
+ | On the ''Available Workbenches'' tab you can specify the following: |
||
− | In FreeCAD version 0.19 the tab has a different label: ''Unloaded Workbenches'', and the tab displays a list of installed workbenches that have not yet been loaded. To load one or more workbenches select them in the list and then press the {{Button|Load Selected}} button. |
||
− | <!--T: |
+ | <!--T:318--> |
+ | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
− | In FreeCAD version 0.20 the ''Available Workbenches'' tab displays a list of all installed workbenches. To load a workbench press its {{Button|Load now}} button. If you check a workbench's {{MenuCommand|Autoload}} checkbox it will autoload when FreeCAD starts up. Loading more workbenches will make the startup slower, but switching between workbenches that have already been loaded is faster. |
||
+ | !style="width: 33%;"|Name |
||
+ | !style="width: 66%;"|Description |
||
+ | |- |
||
+ | | {{MenuCommand|Workbench list}} |
||
+ | | The list displays all installed workbenches. {{Version|0.21}}: The list can be reordered by drag and drop. The order of the list also determines the order of the [[Std_Workbench|Workbench selector]]. |
||
+ | * {{Version|0.21}}: {{MenuCommand|First checkbox in each row}}: If checked, the workbench will be available in the Workbench selector in the next FreeCAD session. The start up workbench cannot be unchecked. Unchecked workbenches are moved to the bottom of the list. |
||
+ | * {{MenuCommand|Auto-load}}: If checked, the workbench will auto-load when FreeCAD starts. Loading more workbenches will make the start up slower, but switching between workbenches that have already been loaded is faster. |
||
+ | * {{Button|Load}}: Press this button to load the workbench in the current FreeCAD session. |
||
+ | |- |
||
+ | | {{MenuCommand|Start up workbench}} |
||
+ | | The workbench that is activated when FreeCAD starts. |
||
+ | |- |
||
+ | | {{MenuCommand|Workbench selector position}} {{Version|0.21}} |
||
+ | | Defines where the [[Std_Workbench|Workbench selector]] appears. The options are: |
||
+ | * '''Toolbar''': In a dedicated toolbar. |
||
+ | * '''Left corner''': In the left corner of the menubar. |
||
+ | * '''Right corner''': In the right corner of the menubar. |
||
+ | |- |
||
+ | | {{MenuCommand|Remember active workbench by tab}} |
||
+ | | If checked, FreeCAD will remember and restore the workbench that was active for each tab in the [[Main_view_area|Main view area]]. |
||
+ | |} |
||
− | <!--T: |
+ | <!--T:313--> |
+ | [[Image:Preferences_Workbenches_Tab_Available_Workbenches.png]] |
||
− | If a newly loaded workbench has dedicated preference they will appear in a new section in the Preferences editor. Some workbenches add support for additional import and export formats. If there are any related preferences they will appear on one or more new tabs in the [[#Import-Export_settings|Import-Export settings]] section of the Preferences editor. |
||
− | <!--T: |
+ | ==Python== <!--T:326--> |
− | For a list of workbench preferences see [[#Workbench_preferences|Workbench preferences]] |
||
− | <!--T: |
+ | <!--T:327--> |
+ | This preferences section ({{Version|0.21}}) has three tabs: Macro, Python console and Editor. |
||
− | [[Image:Preferences_Workbenches_Tab_Available_Workbenches.png]] |
||
− | == |
+ | ===Macro=== <!--T:21--> |
− | <!--T: |
+ | <!--T:206--> |
+ | On the ''Macro'' tab you can specify the following: |
||
− | The Import-Export settings affect how files are imported and exported. They are described on the [[Import_Export_Preferences|Import Export Preferences]] page. |
||
− | + | <!--T:242--> |
|
+ | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
+ | !style="width: 33%;"|Name |
||
+ | !style="width: 66%;"|Description |
||
+ | |- |
||
+ | | {{MenuCommand|Run macros in local environment}} |
||
+ | | If checked, variables defined by macros are created as local variables, otherwise as global Python variables. |
||
+ | |- |
||
+ | | {{MenuCommand|Macro path}} |
||
+ | | Specifies the path for macro files. |
||
+ | |- |
||
+ | | {{MenuCommand|Record GUI commands}} |
||
+ | | If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands. |
||
+ | |- |
||
+ | | {{MenuCommand|Record as comment}} |
||
+ | | If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands, but as comments. This is useful if you don't want to execute these commands when running the macro, but do want to see what has been done while recording. |
||
+ | |- |
||
+ | | {{MenuCommand|Show script commands in python console}} |
||
+ | | If checked, the commands executed by macro scripts are shown in the Python console. This console can be opened using the {{MenuCommand|View → Panels → Python console}} menu option. |
||
+ | |- |
||
+ | | {{MenuCommand|Size of recent macro list}} |
||
+ | | Controls the number of recent macros to display in the menu. |
||
+ | |- |
||
+ | | {{MenuCommand|Shortcut count}} |
||
+ | | Controls the number of recent macros that get dynamically assigned shortcuts. |
||
+ | |- |
||
+ | | {{MenuCommand|Keyboard Modifiers}} |
||
+ | | Controls which keyboard modifiers are used for the shortcuts, example '''Ctrl+Shift+''' creates shortcuts in the form of '''Ctrl+Shift+1''', '''Ctrl+Shift+2''', etc. |
||
+ | |} |
||
− | <!--T: |
+ | <!--T:328--> |
+ | [[Image:Preferences_Python_Tab_Macro.png]] |
||
− | {{VeryImportantMessage|This section is incomplete and requires mentioning the preference pages of each core workbench}} |
||
+ | |||
+ | ===Python console=== <!--T:275--> |
||
+ | |||
+ | <!--T:276--> |
||
+ | These preferences control the behavior of the [[Python_console|Python console]]. This console can be opened using the {{MenuCommand|View → Panels → Python console}} menu option. |
||
+ | |||
+ | <!--T:277--> |
||
+ | Note that the color and font settings for the console are defined on the [[#Editor|Editor]] tab. |
||
+ | |||
+ | <!--T:278--> |
||
+ | On the ''Python console'' tab ({{Version|0.20}}) you can specify the following: |
||
+ | |||
+ | <!--T:279--> |
||
+ | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
+ | !style="width: 33%;"|Name |
||
+ | !style="width: 66%;"|Description |
||
+ | |- |
||
+ | | {{MenuCommand|Enable word wrap}} |
||
+ | | If checked, words will be wrapped if they exceed the available horizontal space in the console. |
||
+ | |- |
||
+ | | {{MenuCommand|Enable block cursor}} |
||
+ | | If checked, the cursor will have a block shape. |
||
+ | |- |
||
+ | | {{MenuCommand|Save history}} |
||
+ | | If checked, Python history is saved across sessions. |
||
+ | |} |
||
+ | |||
+ | <!--T:329--> |
||
+ | [[Image:Preferences_Python_Tab_Python_console.png]] |
||
+ | |||
+ | ===Editor=== <!--T:17--> |
||
+ | |||
+ | <!--T:133--> |
||
+ | These preferences control the behavior of the [[Std_DlgMacroExecute#Edit|Macro editor]]. This editor can be opened using the {{MenuCommand|Macro → Macros... → Edit}} or {{menuCommand|Create}} menu option. |
||
+ | |||
+ | <!--T:204--> |
||
+ | The color and font settings are also used by the [[#Python_console|Python console]]. |
||
+ | |||
+ | <!--T:142--> |
||
+ | On the ''Editor'' tab you can specify the following: |
||
+ | |||
+ | <!--T:239--> |
||
+ | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
+ | !style="width: 33%;"|Name |
||
+ | !style="width: 66%;"|Description |
||
+ | |- |
||
+ | | {{MenuCommand|Enable line numbers}} |
||
+ | | If checked, the code lines will be numbered. |
||
+ | |- |
||
+ | | {{MenuCommand|Enable block cursor}} |
||
+ | | If checked, the cursor will have a block shape. |
||
+ | |- |
||
+ | | {{MenuCommand|Tab size}} |
||
+ | | Specifies the tabulator raster (how many spaces). If it is for example set to '''6''', pressing {{KEY|Tab}} will jump to character 7 or 13 or 19 etc., depending on the current cursor position. This setting is only used if {{MenuCommand|Keep tabs}} is selected. |
||
+ | |- |
||
+ | | {{MenuCommand|Indent size}} |
||
+ | | Specifies how many spaces will be inserted when pressing {{KEY|Tab}}. This setting is only used if {{MenuCommand|Insert spaces}} is selected. |
||
+ | |- |
||
+ | | {{MenuCommand|Keep tabs}} |
||
+ | | If selected, pressing {{KEY|Tab}} will insert a tabulator with the raster defined by {{MenuCommand|Tab size}}. |
||
+ | |- |
||
+ | | {{MenuCommand|Insert spaces}} |
||
+ | | If selected, pressing {{KEY|Tab}} will insert the amount of spaces defined by {{MenuCommand|Indent size}}. |
||
+ | |- |
||
+ | | {{MenuCommand|Display Items}} |
||
+ | | Specifies the code type the color and font settings will be applied to. The result can be checked in the {{MenuCommand|Preview}} field. |
||
+ | |- |
||
+ | | {{MenuCommand|Family}} |
||
+ | | Specifies the font family that should be used for the selected code type. |
||
+ | |- |
||
+ | | {{MenuCommand|Size}} |
||
+ | | Specifies the font size that should be used for the selected code type. |
||
+ | |- |
||
+ | | {{MenuCommand|Color}} |
||
+ | | Specifies the color that should be used for the selected code type. |
||
+ | |} |
||
+ | |||
+ | <!--T:330--> |
||
+ | [[Image:Preferences_Python_Tab_Editor.png]] |
||
+ | |||
+ | ==Addon Manager== <!--T:281--> |
||
+ | |||
+ | <!--T:282--> |
||
+ | This preferences section has a single tab: Addon manager options. |
||
+ | |||
+ | ===Addon manager options=== <!--T:283--> |
||
+ | |||
+ | <!--T:284--> |
||
+ | These preferences control the behavior of the [[Std AddonMgr|Addon manager]]. |
||
+ | |||
+ | <!--T:285--> |
||
+ | On the ''Addon manager options'' tab ({{Version|0.20}}) you can specify the following: |
||
+ | |||
+ | <!--T:286--> |
||
+ | {| class="wikitable float-right mw-collapsible mw-collapsed" |
||
+ | !style="width: 33%;"|Name |
||
+ | !style="width: 66%;"|Description |
||
+ | |- |
||
+ | | {{MenuCommand|Automatically check for updates at start (requires git)}} |
||
+ | | If checked, the Addon manager will check for updates when it is launched. Git must be installed for this to work. |
||
+ | |- |
||
+ | | {{MenuCommand|Download Macro metadata (approximately 10MB)}} |
||
+ | | If checked, macro metadata is downloaded for display in the Addon manager's main addon listing. This data is cached locally. |
||
+ | |- |
||
+ | | {{MenuCommand|Cache update frequency}} |
||
+ | | Controls the frequency with which the locally cached addon availability and metadata information is updated. The options are: |
||
+ | * '''Manual (no automatic updates)''' |
||
+ | * '''Daily''' |
||
+ | * '''Weekly''' |
||
+ | |- |
||
+ | | {{MenuCommand|Hide Addons marked Python 2 Only}} |
||
+ | | If checked, addons marked as "Python 2 Only" are not included in the listing. These addons are unlikely to work in the current FreeCAD version. |
||
+ | |- |
||
+ | | {{MenuCommand|Hide Addons marked Obsolete}} |
||
+ | | If checked, addons marked as "Obsolete" are not included in the listing. |
||
+ | |- |
||
+ | | {{MenuCommand|Hide Addons that require a newer version of FreeCAD}} |
||
+ | | If checked, addons that require a newer FreeCAD version are not included in the listing. |
||
+ | |- |
||
+ | | {{MenuCommand|Custom repositories}} |
||
+ | | Custom repositories can be specified here. |
||
+ | |||
+ | <!--T:294--> |
||
+ | To add a repository press the {{Button|[[Image:List-add.svg|16px]]}} button. Both the {{MenuCommand|Repository URL}} and the {{MenuCommand|Branch}}, typically {{Value|master}} or {{Value|main}}, must be specifies in the dialog that opens. {{Version|0.21}} |
||
+ | |||
+ | <!--T:295--> |
||
+ | To remove a repository select it in the list and press the {{Button|[[Image:List-remove.svg|16px]]}} button. {{Version|0.21}} |
||
+ | |- |
||
+ | | {{MenuCommand|Proxy}} |
||
+ | | The Addon manager includes experimental support for proxies requiring authentication, set up as user-defined proxies. |
||
+ | |- |
||
+ | | {{MenuCommand|Python executable (optional)}} |
||
+ | | The Addon manager attempts to determine the Python executable that should be used for the automatic pip-based installation of Python dependencies. To override this selection, the path to the executable can be set here. |
||
+ | |- |
||
+ | | {{MenuCommand|git executable (optional)}} |
||
+ | | The Addon manager attempts to determine the git executable. To override this selection, the path to the executable can be set here. {{Version|0.21}} |
||
+ | |- |
||
+ | | {{MenuCommand|Show option to change branches (requires git)}} |
||
+ | | If checked, the Addon manager provides an interface on the addon's details screen that allows switching which git branch is currently checked out. This is intended for advanced users only, as it is possible that a non-primary-branch version of an addon may result in instability and compatibility issues. Git must be installed for this to work. Use with caution. |
||
+ | |- |
||
+ | | {{MenuCommand|Disable git (fall back to ZIP downloads only)}} |
||
+ | | If checked, git downloads are disabled. {{Version|0.21}} |
||
+ | |- |
||
+ | | {{MenuCommand|Addon developer mode}} |
||
+ | | If checked, Addon manager options intended for developers of addons are activated. {{Version|0.21}} |
||
+ | |} |
||
+ | |||
+ | <!--T:314--> |
||
+ | [[Image:Preferences_Addon_Manager_Tab_Addon_manager_options.png]] |
||
+ | |||
+ | ==Import-Export== <!--T:143--> |
||
+ | |||
+ | <!--T:196--> |
||
+ | The Import-Export preferences affect how files are imported and exported. They are described on the [[Import_Export_Preferences|Import Export Preferences]] page. |
||
+ | |||
+ | ==Workbench related preferences== <!--T:109--> |
||
<!--T:215--> |
<!--T:215--> |
||
− | Preferences for the |
+ | Preferences for the built-in workbenches are linked below. These links are also listed in [[:Category:Preferences]]. Some workbenches have no preferences. |
− | Some workbenches have no preferences. |
||
− | Other optional workbenches may not be listed. These links are also listed in [[:Category:Preferences]] |
||
<!--T:12--> |
<!--T:12--> |
||
* [[Arch_Preferences|Arch Preferences]] |
* [[Arch_Preferences|Arch Preferences]] |
||
* [[Draft_Preferences|Draft Preferences]] |
* [[Draft_Preferences|Draft Preferences]] |
||
− | * Drawing Preferences (none) {{Obsolete|0.16}} |
||
* [[FEM_Preferences|FEM Preferences]] |
* [[FEM_Preferences|FEM Preferences]] |
||
− | * Image Preferences (none) |
||
* Inspection Preferences (none) |
* Inspection Preferences (none) |
||
− | * Mesh Design Preferences |
+ | * [[Mesh_Workbench#Preferences|Mesh Design Preferences]] |
* [[OpenSCAD_Preferences|OpenSCAD Preferences]] |
* [[OpenSCAD_Preferences|OpenSCAD Preferences]] |
||
<!--The PartDesign preferences are defined in the Part workbench and both the PartDesign workbench and the Part workbench use them--> |
<!--The PartDesign preferences are defined in the Part workbench and both the PartDesign workbench and the Part workbench use them--> |
||
Line 654: | Line 881: | ||
* [[PartDesign_Preferences|PartDesign Preferences]] |
* [[PartDesign_Preferences|PartDesign Preferences]] |
||
* [[Path_Preferences|Path Preferences]] |
* [[Path_Preferences|Path Preferences]] |
||
− | * Plot Preferences (none) |
||
* Points Preferences (none) |
* Points Preferences (none) |
||
* [[Raytracing_Preferences|Raytracing Preferences]] |
* [[Raytracing_Preferences|Raytracing Preferences]] |
||
Line 660: | Line 886: | ||
* Robot Preferences (none) |
* Robot Preferences (none) |
||
* [[Sketcher_Preferences|Sketcher Preferences]] |
* [[Sketcher_Preferences|Sketcher Preferences]] |
||
− | * Spreadsheet Preferences |
+ | * [[Spreadsheet_Preferences|Spreadsheet Preferences]] |
* [[Start_Preferences|Start Preferences]] |
* [[Start_Preferences|Start Preferences]] |
||
* Surface Preferences (none) |
* Surface Preferences (none) |
||
Line 666: | Line 892: | ||
* Test Framework Preferences (none) |
* Test Framework Preferences (none) |
||
* Web Preferences (none) |
* Web Preferences (none) |
||
− | |||
− | ===External workbenches=== <!--T:212--> |
||
− | |||
− | <!--T:216--> |
||
− | {{VeryImportantMessage|This section is incomplete and requires mentioning the preference pages of each [[External_workbenches|External workbench]]}} |
||
− | |||
− | <!--T:140--> |
||
− | * [[A2plus_Workbench#Preferences|A2plus Preferences]] |
||
− | * Ship Preferences (none) |
||
==Scripting== <!--T:224--> |
==Scripting== <!--T:224--> |
Latest revision as of 10:36, 7 June 2023
Introduction
To start the Preferences editor select the Edit → Preferences... option from the menu. On macOS the Preferences... option appears in the FreeCAD menu instead (this is the default place for preferences on the Mac).
FreeCAD uses a workbench concept, where each workbench is responsible for specific tasks and functions. A workbench can have its own preferences. These will only appear in the Preferences editor, usually in a dedicated section, if the workbench has been loaded in the current FreeCAD session. Some workbenches add support for specific import and export formats. If there are any related preferences they will appear on one or more additional tabs in the Import-Export section of the Preferences editor.
To preserve resources, FreeCAD does not automatically load all available workbenches. See Workbenches for more information. For a list of workbench related preferences see Workbench related preferences.
If no workbench is loaded, six sections appear in the Preferences editor: General, Display, Workbenches, Python, Addon Manager and Import-Export. Any workbenches that have been loaded, and have their own preferences, will appear below these.
Please note that pressing the Reset button in the lower left corner of the Preferences dialog will reset all FreeCAD preferences to their default values.
Some advanced preferences can only be changed in the Parameter editor. The Fine-tuning page lists some of them.
General
This preferences section has six standard tabs: General, Document, Selection, Cache, Notification Area and Report view. A seventh tab, Help, is added if the Help Addon is available. This addon can be installed via the Addon Manager.
General
On the General tab you can specify the following:
Name | Description |
---|---|
Language | Specifies the language of the FreeCAD user interface. |
Unit system | Specifies the unit system to be used for all parts of FreeCAD. |
Number of decimals | The number of decimals that should be shown for numbers and dimensions. |
Number format introduced in version 0.20 | Specifies the number format. The options are:
|
Substitute decimal separator introduced in version 0.20 | If checked, the numerical keypad decimal separator will be substituted with the separator defined by the Number format setting. introduced in version 0.21: Notice that if this preference is enabled, using the numerical keypad decimal separator will always print a dot/period in the Python console and the Macro editor. |
Style sheet | Specifies a style sheet. Style sheets define how the user interface of FreeCAD looks. For technical details about style sheets see themes. |
Size of toolbar icons | Specifies the size of the toolbar icons. The options are:
|
Tree view mode | Defines how the tree view is shown in the user interface (restart required). The options are:
|
Size of recent file list | Specifies how many files should be listed in the recent files list. |
Enable tiled background | If checked, the background of FreeCAD's main window will by default consist of tiles of this image: ![]() This option only has an effect if no Style sheet is selected. The image can be changed by adding the folders Gui/Images in the folder: %APPDATA%/FreeCAD (on Windows), $HOME/.FreeCAD (on Linux) or $HOME/Library/Preferences/FreeCAD (on macOS). Place a file named background.png in the Images folder, and uncheck/check this option to see the changed file. |
Enable splash screen at start up | If checked, a splash screen is shown when starting FreeCAD.
The splash screen image can be changed by placing a file named splash_image.png in the Images folder already mentioned under Enable tiled background. |
Enable cursor blinking | If checked the text cursor in the Python console and the Macro editor will blink. |
Preference packs introduced in version 0.20 | Lists the available preference packs and also allows you to import, save, manage and revert them. |
Document
On the Document tab you can specify the following:
Name | Description |
---|---|
Create new document at start up | If checked, FreeCAD will create a new document when started. |
Document save compression level | Specifies the compression level for FCStd files. FCStd files are ZIP-compressed files. Therefore you can rename their suffix .FCStd to .zip and open them with a ZIP archive program. |
Using Undo/Redo on documents | If checked, all changes in documents are stored so that they can be undone/redone. |
Maximum Undo/Redo steps | Specifies how many Undo/Redo steps should be recorded. |
Allow aborting recomputation | If checked, recomputations can be aborted by pressing Esc. This may slightly increase the recomputation time. |
Run AutoRecovery at startup | If there is a recovery file available FreeCAD will automatically run a file recovery when it is started. This way files can be restored if a crash occurred. |
Save AutoRecovery information every | Specifies how often a recovery file is written. |
Save thumbnail into project file when saving document | If checked, a thumbnail will be stored when the document is saved. The thumbnail will for example be shown in the list of recent files in the Start Workbench. It is possible to select a Size between 128×128 and 512×512 pixels for the thumbnail. Common sizes are powers of two: 128, 256, 512. |
Add the program logo to the generated thumbnail | If checked, the FreeCAD program logo |
Maximum number of backup files to keep when resaving document | If checked, backup files will be kept when saving the document. You can specify the number of backup files to keep. Backup files are previously saved versions of the document. The first backup file will have the file suffix .FCStd1, the second .FCStd2 and so on. |
Use date and FCBak extension | If checked, backup files will get the extension .FCbak and their file names get a date suffix according to the specified Date format. For a description of the date format see Date & time formats cheatsheet.
With the default settings a backup file will for example get this name TD-Cube.20200315-215654.FCBak (original filename is TD-Cube.FCStd). |
Allow duplicate object labels in one document | If checked, objects can have the same label. |
Disable partial loading of external linked objects | If partial loading of external linked objects is enabled, only the referenced objects and their dependencies will be loaded when the linked document is auto opened together with the main document. Such a partially loaded document cannot be edited. Double click the document icon in the tree view to reload it in full. A more detailed explanation of this feature can be found on the Assembly3 documentation page. |
Author name | All created documents will get the specified author name. Keep the author field blank if you do not want to include this information. If the option Set on save is checked, the field Last modified by will be set to the specified author when saving the file. This field can be viewed using the File → Project information menu option. |
Company | All created documents will get the specified company name. |
Default license | Specifies the license for new documents. For predefined licenses the License URL will automatically be set accordingly. Select Other for a custom license. |
License URL | Specifies an URL describing the license selected in Default license. |
Selection
On the Selection tab you can specify the following:
Name | Description |
---|---|
Auto switch to the 3D view containing the selected item | Enables the Tree view SyncView mode. |
Auto expand tree item when the corresponding object is selected in 3D view | Enables the Tree view SyncSelection mode. |
Preselect the object in 3D view when mouse over the tree item | Enables the Tree view PreSelection mode. |
Record selection in tree view in order to go back/forward using navigation button | Enables the Tree view RecordSelection mode. |
Add checkboxes for selection in document tree | Each Tree view item will get a checkbox. This is for example useful for selecting multiple items on a touchscreen. |
Cache
These preferences are related to the cache directory where FreeCAD stores temporary files.
On the Cache tab (introduced in version 0.20) you can specify the following:
Name | Description |
---|---|
Location | Specifies the path of the cache directory. |
Check periodically at program start | Controls the frequency with which the directory size is checked. The options are:
|
Cache size limit | Specifies the maximum size of the directory. You will be notified if a check is performed and the size exceeds this value. The options are:
|
Current cache size | Shows the current size of the directory, if available. Press the Check now... button to update the value. |
Notification Area
These preferences control the Notification Area and its notifications.
On the Notification Area tab (introduced in version 0.21) you can specify the following:
Name | Description |
---|---|
Enable Notification Area | If checked, the Notification Area will appear in the status bar. |
Enable non-intrusive notifications | If checked, non-intrusive notifications will appear next to the Notification Area in the status bar. |
Errors | If checked, errors will appear in the Notification Area. |
Warnings | If checked, warnings will appear in the Notification Area. |
Maximum Duration | Maximum duration during which notifications are shown (unless mouse buttons are clicked). |
Minimum Duration | Minimum duration (idem). |
Maximum Number of Notifications | Maximum number of notifications shown simultaneously. |
Notification width | Width of the Notification Area in pixels. |
Hide when other window is activated | If checked, open notifications will disappear when another window is activated. |
Do not show when inactive | If checked, notifications will not appear if the FreeCAD window is not the active window. |
Maximum Messages (0 = no limit) | The maximum number of messages kept in the list. Set to 0 for no limit. |
Auto-remove User Notifications | If checked, notifications will be removed from the message list when the Maximum Duration has elapsed. |
Report view
These preferences control the behavior of the Report view. This panel can be opened using the View → Panels → Report view menu option.
On the Report view tab you can specify the following:
Name | Description |
---|---|
Record normal messages | If checked, normal messages will be recorded. They will be displayed in the Report view with the color set in Normal messages. |
Record log messages | If checked, log messages will be recorded. They will be displayed in the Report view with the color set in Log messages. |
Record warnings | If checked, warnings will be recorded. They will be displayed in the Report view with the color set in Warnings. |
Record error messages | If checked, error messages will be recorded. They will be displayed in the Report view with the color set in Errors. |
Show report view on error | If checked, the Report view will be shown automatically when an error is recorded. |
Show report view on warning | If checked, the Report view will be shown automatically when a warning is recorded. |
Show report view on normal message | If checked, the Report view will be shown automatically when a normal message is recorded. |
Show report view on log message | If checked, the Report view will be shown automatically when a log message is recorded. |
Include a timecode for each entry | If checked, each message and warning will receive a timecode. |
Normal messages | Specifies the font color for normal messages. |
Log messages | Specifies the font color for log messages. |
Warnings | Specifies the font color for warning messages. |
Errors | Specifies the font color for error messages. |
Redirect internal Python output to report view | If checked, internal Python output will be redirected from the Python console to the Report view. |
Redirect internal Python errors to report view | If checked, internal Python error messages will be redirected from the Python console to the Report view. |
Help
This tab is only available if the Help Addon has been installed.
On the Help tab you can specify the following:
Name | Description |
---|---|
Help location | Specifies the location of the Help files. The options are:
|
Display | Specifies where the documentation should be displayed. The options are:
|
Custom stylesheet | Specifies an optional custom stylesheet. Not used for the Wiki URL. |
Display
This preferences section has three standard tabs: 3D View, Navigation and Colors. A fourth tab, Mesh view, is added if the Mesh Workbench has been loaded.
3D View
On the 3D View tab you can specify the following:
Name | Description |
---|---|
Show coordinate system in the corner | If checked, the main coordinate system will be shown in the lower right corner of the 3D view.
The Relative size (introduced in version 0.20) defines the size of the representation as a percentage of the view size (the minimum of its height and width). |
Show axis cross by default | If checked, the axis cross will be shown by default in the 3D view. |
Show counter of frames per second | If checked, the time needed for the last operation and the resulting frame rate will be shown in the lower left corner of the 3D view. |
Use software OpenGL | If checked, OpenGL will use the CPU instead of the GPU. This option is useful for troubleshooting graphics card and driver problems. Changing this option requires a restart of the application. |
Use OpenGL VBO (Vertex Buffer Object) | If checked, Vertex Buffer Objects (VBO) will be used. A VBO is an OpenGL feature that provides methods for uploading vertex data (position, normal vector, color, etc.) to the graphics card. VBOs offer substantial performance gains because the data resides in the graphics memory rather than the system memory and so it can be rendered directly by the GPU. For more background info see Understanding OpenGL Objects. |
Render Cache | "Render Cache" or "Render Acceleration" is explained in more detail in FreeCAD assembly3 render-caching. The options are:
|
Anti-Aliasing | Specifies if and what type of multisample anti-aliasing is used |
Transparent objects | Specifies the render type of transparent objects. The options are:
|
Marker size | Specifies the size of vertices (points) in the Sketcher Workbench. The clickable area of points can be additionally enlarged by increasing the Pick radius. |
Pick radius (px) | Sets the area for picking elements in the 3D view. Larger value makes it easier to pick things, but can make some small features impossible to select. |
Eye to eye distance for stereo modes | Specifies the eye-to-eye distance used for stereo projections. The specified value is a factor that will be multiplied with the bounding box size of the 3D object that is currently displayed. |
Backlight color | If checked, backlight is enabled with the defined color. Backlight is used for rendering the back sides of faces. Usually, you don't see them in solids, unless you slice one with a clipping plane, or if the faces aren't oriented correctly. It is only used for objects whose Lighting property (on the View tab) is set to One side. If disabled, the back side of the faces of those objects will be black.
The related Intensity setting specifies the intensity of the backlight. |
Camera type | Specifies the camera projection type. The options are:
|
On the Navigation tab you can specify the following:
Name | Description |
---|---|
Navigation cube | If checked, the Navigation cube will be shown in the 3D view.
Steps by turn defines the number of steps required for a full rotation when using the Navigation cube rotation arrows. If Rotate to nearest is checked, the 3D view is rotated to the nearest most logical position, based on the current orientation of the cube, when a cube face is clicked. Else clicking a face will always result in the same rotation. introduced in version 0.20 Cube size defines the size of the cube. introduced in version 0.20 Color sets the base color for all elements. introduced in version 0.21 Corner defines where the Navigation cube is displayed in the 3D view. The options are:
Font name specifies the font used for the cube's texts. introduced in version 0.21 Font size sets the size of the font used for the cube's texts. introduced in version 0.21 |
3D Navigation | Specifies a mouse navigation style. To see the details of each style, select it and then press the Mouse... button. |
Orbit style | Specifies the rotation orbit style used when in rotation mode. The options are:
|
Rotation mode | Defines the rotation center. The options are:
|
Default camera orientation | Specifies the camera orientation for new documents. This setting is also used by the Std ViewHome command. |
Camera zoom | Affects the initial camera zoom level for new documents. The value you set is the diameter of a sphere that fits in 3D view. The default is 100 mm. It also sets the initial size of origin features (base planes in new PartDesign Bodies and Std Parts). |
Enable animation | If checked, and 3D Navigation is set to CAD, rotations can be animated. If the mouse is moved while the scroll wheel and the right mouse button are pressed, the view is rotated. If one keeps the mouse moving while releasing the right mouse button, the rotation will continue. To end this animation left-click with the mouse. |
Zoom at cursor | If checked, zoom operations will be performed at the position of the mouse pointer. Otherwise zoom operations will be performed at the center of the current view. The Zoom step defines how much will be zoomed. A zoom step of 1 means a factor of 7.5 for every zoom step. |
Invert zoom | If checked, the direction of zoom operations will be inverted. |
Disable touchscreen tilt gesture | If checked, and 3D Navigation is set to Gesture, the tilting gesture will be disabled for pinch-zooming (two-finger zooming). |
Colors
On the Colors tab you can specify the following:
Name | Description |
---|---|
Enable preselection highlighting | If checked, preselection is turned on and the specified color will be used for it. Preselection means that for example edges of objects will be highlighted while hovering over them with the mouse to indicate they can be selected. |
Enable selection highlighting | If checked, selection highlighting is turned on and the specified color will be used for it. |
Simple color | If selected, the background of the 3D view will have the specified color. |
Linear gradient | If selected, the background of the 3D view will have a vertical color gradient defined by the specified Top and Bottom colors. if enabled, a Middle color can also be specified. Press the |
Radial gradient introduced in version 0.21 | If selected, the background of the 3D view will have a radial color gradient defined by the specified Central and End colors. if enabled, a Midway color can also be specified. Press the |
Object being edited | Specifies the background color for objects in the tree view that are currently edited. |
Active container | Specifies the background color for active containers in the tree view. For example an active PartDesign Body will get this color. |
Mesh view
This tab is only available if the Mesh Workbench has been loaded.
On the Mesh view tab you can specify the following:
Name | Description |
---|---|
Default mesh color | Specifies the default face color. |
Default line color | Specifies the default line color. |
Mesh transparency | Specifies the default mesh transparency. |
Line transparency | Specifies the default line transparency. |
Two-side rendering | If checked, the default value for the ViewLighting property is Two side instead of One side . Two side means the color of the interior side of faces is the same as the color of the exterior side. One side means their color is either the backlight color, if enabled, or black.
|
Show bounding-box for highlighted or selected meshes | If checked, the default value for the ViewSelection Style property is BoundBox instead of Shape . BoundBox means a highlighted bounding box is displayed if meshes are highlighted or selected. Shape means the shape itself is then highlighted.
|
Define normal per vertex | If checked, Phong shading is used, otherwise flat shading. Shading defines the appearance of surfaces. With flat shading the surface normals are not defined per vertex. This leads to an unrealistic appearance for curved surfaces. While Phong shading leads to a more realistic, smoother appearance. |
Crease angle | The crease angle is a threshold angle between two faces. It can only be set if the option Define normal per vertex is used.
|
Workbenches
This preferences section has a single tab: Available Workbenches.
Available Workbenches
These preferences control workbench loading.
On the Available Workbenches tab you can specify the following:
Name | Description |
---|---|
Workbench list | The list displays all installed workbenches. introduced in version 0.21: The list can be reordered by drag and drop. The order of the list also determines the order of the Workbench selector.
|
Start up workbench | The workbench that is activated when FreeCAD starts. |
Workbench selector position introduced in version 0.21 | Defines where the Workbench selector appears. The options are:
|
Remember active workbench by tab | If checked, FreeCAD will remember and restore the workbench that was active for each tab in the Main view area. |
Python
This preferences section (introduced in version 0.21) has three tabs: Macro, Python console and Editor.
Macro
On the Macro tab you can specify the following:
Name | Description |
---|---|
Run macros in local environment | If checked, variables defined by macros are created as local variables, otherwise as global Python variables. |
Macro path | Specifies the path for macro files. |
Record GUI commands | If checked, recorded macros will also contain user interface commands. |
Record as comment | If checked, recorded macros will also contain user interface commands, but as comments. This is useful if you don't want to execute these commands when running the macro, but do want to see what has been done while recording. |
Show script commands in python console | If checked, the commands executed by macro scripts are shown in the Python console. This console can be opened using the View → Panels → Python console menu option. |
Size of recent macro list | Controls the number of recent macros to display in the menu. |
Shortcut count | Controls the number of recent macros that get dynamically assigned shortcuts. |
Keyboard Modifiers | Controls which keyboard modifiers are used for the shortcuts, example Ctrl+Shift+ creates shortcuts in the form of Ctrl+Shift+1, Ctrl+Shift+2, etc. |
Python console
These preferences control the behavior of the Python console. This console can be opened using the View → Panels → Python console menu option.
Note that the color and font settings for the console are defined on the Editor tab.
On the Python console tab (introduced in version 0.20) you can specify the following:
Name | Description |
---|---|
Enable word wrap | If checked, words will be wrapped if they exceed the available horizontal space in the console. |
Enable block cursor | If checked, the cursor will have a block shape. |
Save history | If checked, Python history is saved across sessions. |
Editor
These preferences control the behavior of the Macro editor. This editor can be opened using the Macro → Macros... → Edit or Create menu option.
The color and font settings are also used by the Python console.
On the Editor tab you can specify the following:
Name | Description |
---|---|
Enable line numbers | If checked, the code lines will be numbered. |
Enable block cursor | If checked, the cursor will have a block shape. |
Tab size | Specifies the tabulator raster (how many spaces). If it is for example set to 6, pressing Tab will jump to character 7 or 13 or 19 etc., depending on the current cursor position. This setting is only used if Keep tabs is selected. |
Indent size | Specifies how many spaces will be inserted when pressing Tab. This setting is only used if Insert spaces is selected. |
Keep tabs | If selected, pressing Tab will insert a tabulator with the raster defined by Tab size. |
Insert spaces | If selected, pressing Tab will insert the amount of spaces defined by Indent size. |
Display Items | Specifies the code type the color and font settings will be applied to. The result can be checked in the Preview field. |
Family | Specifies the font family that should be used for the selected code type. |
Size | Specifies the font size that should be used for the selected code type. |
Color | Specifies the color that should be used for the selected code type. |
Addon Manager
This preferences section has a single tab: Addon manager options.
Addon manager options
These preferences control the behavior of the Addon manager.
On the Addon manager options tab (introduced in version 0.20) you can specify the following:
Name | Description |
---|---|
Automatically check for updates at start (requires git) | If checked, the Addon manager will check for updates when it is launched. Git must be installed for this to work. |
Download Macro metadata (approximately 10MB) | If checked, macro metadata is downloaded for display in the Addon manager's main addon listing. This data is cached locally. |
Cache update frequency | Controls the frequency with which the locally cached addon availability and metadata information is updated. The options are:
|
Hide Addons marked Python 2 Only | If checked, addons marked as "Python 2 Only" are not included in the listing. These addons are unlikely to work in the current FreeCAD version. |
Hide Addons marked Obsolete | If checked, addons marked as "Obsolete" are not included in the listing. |
Hide Addons that require a newer version of FreeCAD | If checked, addons that require a newer FreeCAD version are not included in the listing. |
Custom repositories | Custom repositories can be specified here.
To add a repository press the To remove a repository select it in the list and press the |
Proxy | The Addon manager includes experimental support for proxies requiring authentication, set up as user-defined proxies. |
Python executable (optional) | The Addon manager attempts to determine the Python executable that should be used for the automatic pip-based installation of Python dependencies. To override this selection, the path to the executable can be set here. |
git executable (optional) | The Addon manager attempts to determine the git executable. To override this selection, the path to the executable can be set here. introduced in version 0.21 |
Show option to change branches (requires git) | If checked, the Addon manager provides an interface on the addon's details screen that allows switching which git branch is currently checked out. This is intended for advanced users only, as it is possible that a non-primary-branch version of an addon may result in instability and compatibility issues. Git must be installed for this to work. Use with caution. |
Disable git (fall back to ZIP downloads only) | If checked, git downloads are disabled. introduced in version 0.21 |
Addon developer mode | If checked, Addon manager options intended for developers of addons are activated. introduced in version 0.21 |
Import-Export
The Import-Export preferences affect how files are imported and exported. They are described on the Import Export Preferences page.
Preferences for the built-in workbenches are linked below. These links are also listed in Category:Preferences. Some workbenches have no preferences.
- Arch Preferences
- Draft Preferences
- FEM Preferences
- Inspection Preferences (none)
- Mesh Design Preferences
- OpenSCAD Preferences
- Part Preferences: the Part workbench also uses the PartDesign Preferences
- PartDesign Preferences
- Path Preferences
- Points Preferences (none)
- Raytracing Preferences
- Reverse Engineering Preferences (none)
- Robot Preferences (none)
- Sketcher Preferences
- Spreadsheet Preferences
- Start Preferences
- Surface Preferences (none)
- TechDraw Preferences
- Test Framework Preferences (none)
- Web Preferences (none)
Scripting
See also: FreeCAD Scripting Basics.
For a scripting example see Std DlgParameter.
Related

- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub