首选项编辑器

From FreeCAD Documentation
This page is a translated version of the page Preferences Editor and the translation is 10% complete.
Outdated translations are marked like this.

Introduction

FreeCAD的首选项系统位于Edit menu → Preferences

FreeCAD中的功能被分为不同的模块,每个模块负责实现一种特定workbench的具体工作。 FreeCAD采用的是延迟加载方式,意即只有当需要使用特定组件时才会进行加载。您在FreeCAD的工具栏中选择工作台时可能会注意到这一点,因为在加载工作台及其所有组件时需要花费一点儿时间。在进行首选项设置时也是如此。

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.

在没有加载任何模块时,您可以访问两个配置部分,分别用于应用通用设置(general)与显示设置(display)。当您使用特定的工作台时,便会在新选项卡中显示对应工作台的首选项设置,并在Import-Export新加部分显示该工作台所支持的文件格式。

点击首选项左下角的Reset按钮,即可将FreeCAD中的所有首选项设置还原为其默认值。

Some advanced preferences can only be changed in the Parameter editor. The Fine-tuning page lists some of them.

通用设置

本首选项部分包含6个选项卡:

In version 0.21 and below the seventh tab, Help, is only available if the Help Addon has been installed.

常规

General选项卡中,您可以指定下列内容:

名称 描述
更改语言 选择FreeCAD的用户界面语言
最近文件列表大小 指定有多少最近用过的文件显示在recent files列表中
启用平面背景 如果选中此复选框,则FreeCAD的主窗口背景将默认由以下图片填充:
本选项只有在样式表:/No style sheet被选中时才会生效。
将图片加入到下列路径中的Gui/Images文件夹下即可改变贴图内容
%APPDATA%/FreeCAD (在Windows上),
$HOME/.FreeCAD (在Linux上) or
$HOME/Library/Preferences/FreeCAD (在MacOS上)。
将图片文件命名为background.png,再依次取消/选中本选项来查看效果。

Optionally, imported files can be excluded from this list, and exported files can be included. See Fine-tuning.

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.
样式表: 选择样式表。样式表定义了FreeCAD用户界面的外观。
工具栏图标大小 选择工具栏图标的大小。
启动后自动加载模块 选择FreeCAD开启后将直接打开的工作台。
打开软件启动界面 如果选中此项, 则在FreeCAD开启时展示启动画面。
可通过向%APPDATA%/FreeCAD( %APPDATA%是用户在操作系统中为FreeCAD指定的应用文件夹)添加Gui/Images文件夹来修改启动画面。将作为启动画面的图像命名为splash_image.png并重启FreeCAD即可看到效果。
启用自动换行 利用此选项可实现在Python控制台中令超出一行中的文本自动换行。利用View → Panels → Python console菜单来开启Python控制台。

文档

Document选项卡中,您可以指定以下内容:

名称 描述
启动时创建新文档 如果选中此选项,FreeCAD将在启动时创建一个新文档。
Document save compression level 指定FCStd文件的压缩级别。FCStd文件为ZIP压缩文件。因此,您可以将其后缀.FCStd改为.zip,并用ZIP归档程序来打开它们。
在文档上使用撤消/重做 如果选中此选项,所有文档的更改情况将被保存下来,因此即可实现undone/redone。
最大撤消/重做步数 指定可以记录多少次Undo/Redo操作。
在启动时运行自动恢复 如果存在恢复文件,则FreeCAD将在开启时自动运行此文件进行恢复。此法可对程序崩溃时的文件进行恢复。
每次都保存自动恢复信息 指定多久写一次恢复文件。
保存文件时同时保存缩略图到项目文件 如果选中此选项,在保存文档时,也将存储一份项目的缩略图。此缩略图将显示在启动工作台中的最近打开文件列表中。
将程序徽标添加到生成的缩略图 如果选中此选项,则会将FreeCAD程序的logo 添加至缩略图中。此选项仅在开启保存文件时同时保存缩略图到项目文件选项后才会生效。
保存文档时要保留的最大备份文件数 如果选中此选项,在保存文档时也会保留备份文件。您可以指定保留备份文件的数量。这些文件中保存的是此前(previously)的文档版本。第一个备份文件的后缀为 .FCStd1, 第二个后缀为.FCStd2,并以此类推。
在一个文档中允许重复的对象标签 如果选中此选项,则不同的对象可以使用相同的标签/名称。例如,同一文档中的不同零件与features可用相同的名字。
作者姓名 创建的所有文档均采用此指定的作者名。对于匿名作者而言,作者名字的区域为空白内容。若开启了保存时的设置选项,则在保存文件时将Last modified by的内容设置为此作者名。可通过File → Project information菜单来查看该文本域。
公司 将创建的所有文档都指定为此公司名称。
默认许可证 为新文档所指定的默认许可证。对于预定义的许可证而言,许可证网址将自动做出对应的设置。而针对自定义许可证或特殊许可证来讲,可选择'Other(其他)'项。
许可证网址 指定URL来描述默认许可证中所选的许可证。

选择

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:
  • Always
  • Daily
  • Weekly
  • Monthly
  • Yearly
  • Never
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
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:

名称 描述
Record normal messages If checked, normal messages will be recorded. They will be displayed in the Report view with the color set in 正常的消息.
记录日志 If checked, log messages will be recorded. They will be displayed in the Report view with the color set in 日志信息.
记录警告 If checked, warnings will be recorded. They will be displayed in the Report view with the color set in 警告.
记录错误 If checked, error messages will be recorded. They will be displayed in the Report view with the color set in 错误.
错误时显示报表视图 If checked, the Report view will be shown automatically when an error is recorded
在警告时显示报告视图 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
在日志消息中显示报告视图 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
正常的消息 Specification of the font color for normal messages
日志信息 Specification of the font color for log messages
警告 Specification of the font color for warning messages
错误 Specification of the font color for error messages
将 Python 内部输出重定向到报告视图 If checked, internal Python output will be redirected from the Python console to the Report view
将 Python 内部错误重定向到报告视图 If checked, internal Python error messages will be redirected from the Python console to the Report view

Help

On the Help tab you can specify the following:

Name Description
Help location Specifies the location of the Help files. The options are:
  • Online: Enter the URL or leave blank to use the automatic GitHub URL.
Translation suffix: If https://wiki.freecad.org/ is used, a language suffix can be specified. Use for example fr for the French translation. Must be blank for the GitHub URL.
  • 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 Addon Manager.
Display Specifies where the documentation should be displayed. The options are:
  • In a new FreeCAD tab: The documentation is displayed on a new tab in the Main view area.
  • In your default web browser: The documentation is displayed in the default web browser.
  • In a separate, embeddable, dialog: The documentation is displayed in a separate dialog. This dialog can be docked on top of the Combo view for example.
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.

三维视图

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:
  • Auto: Let Coin3D decide where to cache (default).
  • Distributed: Manually turn on cache for all view provider root nodes.
  • 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.
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:
  • 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: Rendering is done in two passes. Back-facing polygons are rendered in the first pass and front-facing polygons in the second pass.
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:

  • Top left
  • Top right
  • Bottom left
  • Bottom right

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:
  • 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. introduced in version 0.21
Rotation mode Defines the rotation center. The options are:
  • Window center
  • Drag at cursor
  • Object center
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).
Enable rotation center indication If checked, the rotation center of the view is shown when dragging. introduced in version 0.22

颜色

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 button (introduced in version 0.21) to switch the top and bottom colors.
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 button to switch the central and end colors.
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.

网格视图

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 视图Lighting 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 视图Selection 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.
If face angle ≥ crease angle, facet shading is used.
If face angle < crease angle, smooth shading 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. The list can be reordered by drag and drop (introduced in version 0.21) and sorted by right-clicking the list and selecting Sort alphabetically (introduced in version 0.22). The order of the list also determines the order of the Workbench selector.
  • introduced in version 0.21: 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.
  • 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.
  • Load: Press this button to load the workbench in the current FreeCAD session.
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:
  • Toolbar: In a dedicated toolbar.
  • Left corner: In the left corner of the menubar.
  • Right corner: In the right corner of the menubar.
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.

On the Macro tab you can specify the following:

名称 描述
在本地环境中运行宏 If checked, variables defined by macros are created as local variables, otherwise as global Python variables
宏路径 Specification of the path for macro files
录制图形用户界面命令 If checked, recorded macros will also contain user interface commands
录制为注释 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.
在Python控制台显示脚本 If checked, the commands executed by macro scripts are shown in the Python console. This console is shown using the View → Panels → Python console menu option.
Size of recent macros list Controls the number of recent macros to display in the menu
快捷方式计数 Controls the number of recent macros that get dynamically assigned shortcuts
键盘编辑器 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.

编辑器

编辑器首选项设置影响的是宏编辑器的行为。此编辑器可通过Macro → Macros... → Edit/Create菜单打开。
请注意: 这里的颜色和字体设置也会影响到Python控制台。此控制台可通过View → Panels → Python console菜单打开。

The color and font settings are also used by the Python console.

Editor选项卡中,您可以指定以下内容:

名称 描述
Display Items 选择代码类型。此处的颜色与字体设置将应用于所选的代码类型。可以从Preview框中预览效果。
字体族 指定应用于所选代码类型的字体系列(font family)。
大小 指定应用于所选代码类型的字体大小。
启用行号 若开启此项,将显示代码行号。
制表符长度 指定一个tab符占多少空格位置。若将此值设置为'6',则多次按下Tab键后,将根据当前光标位置,依次跳至其后的第7个字符、第13个字符或第19个字符等处。只有在选中保留制表符后,本选项才可生效。
缩进大小 指定在按下Tab键后将会插入多少个空格。只有在选中插入空格后,本选项才会生效。
保留制表符 如果选择本项,则按下Tab键将插入占空为制表符长度的tab符。
插入空格 如果选择本项,则按下Tab键将插入数量为缩进大小的空格符。

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:
  • Manual (no automatic updates)
  • Daily
  • Weekly
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 button. Both the Repository URL and the Branch, typically master or main, must be specifies in the dialog that opens. introduced in version 0.21

To remove a repository select it in the list and press the button. introduced in version 0.21

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.

Scripting

See also: FreeCAD Scripting Basics.

For a scripting example see Std DlgParameter.

Related