1 .. _setting_preferences_page:
7 All user preferences of **SALOME** application can be customized using the
8 common **Preferences** dialog box. This dialog can be open using the
9 ***File > Preferences...*** menu item.
11 The **Preferences** dialog box consists of two parts:
13 - Available preferences sections are listed in the left part of the dialog box; usually this list contains "SALOME" item that specifies general application preferences and a separate section for each SALOME module available in the current session.
14 - The tabbed widget at the right side of the dialog box provides controls that can be used to customize the preferences.
16 .. note:: The preferences for modules become accessible only after explicit loading of these modules. Until then the dialog box will show the corresponding warning message.
18 More detailed information about preferences for certain modules can be found in the User's guide of the corresponding module.
20 General application preferences are specified in the **SALOME** section
21 of the **Preferences** dialog box. These preferences affect on the
22 application look-n-feel and common functionality.
24 If the study has just been started and other
25 modules have not been loaded yet, it will be possible to change only the settings which refer to
26 the whole GUI SALOME session.
31 .. image:: ../images/pref_salome_general.png
36 - **Current language** - the language used by the application GUI. The language change will come in force only after the application is restarted.
37 - **Use C locale** - when checked, the C locale will be set for the application, otherwise a system locale will be used. The locale change will come in force only after the application is restarted.
41 - **Show splash screen at start-up** - allows showing or hiding the splash screen at start-up.
42 - **Opaque resize** - force opaque resize mode for viewers area (tabbed workspace). Clear this checkbox for less perfomant workstations.
43 - **Drop-down buttons in toolbars for action groups** - when checked, the action groups are represented in the viewer toolbars as a single drop-down button, switchable by the user. Otherwise, all the buttons from the action groups are displayed in the toolbar.
45 - **Study Properties**
47 - **Multi file save** - if checked in, your study will be saved in several HDF files (one basic HDF file which will store the main information about the saved study and several other files for the data created by each component used during the study session). Opening of this study requires that **ALL** saved files should be stored in the **SAME** directory. If you would like to copy your saved study in another directory or machine, you should copy all stored files. Otherwise, if you try to open this study, some data will be lost and it will lead to invalid functioning of the SALOME platform.
48 - **ASCII save** - if checked in, your study will be saved in ASCII format file (or files).
49 - **Automatic loading of light modules when opening study** - if checked in, Light Modules of the current study will be automatically loaded at the next study opening, allowing completion of object browser.
50 - **Store positions of windows** - if checked in, positions of windows will be saved in a special file at the end of the current session and then restored for a new session.
51 - **Store positions of toolbars** - if checked in, positions of toolbars will be saved in a special file at the end of the current session and then restored for a new session.
52 - **Auto-save interval (min)** - allows to specify the time interval (in minutes) for automatic study saving operation. If the time interval is equal to 0 ("Disabled" value is shown) the automatic saving is not performed.
53 - **Store/restore last GUI state** - if checked in, all GUI settings are saved with the rest of the data whenever you save the study. When the study is reopened, the GUI state is restored.
54 - **Publish in study in python dump** - if this option is switched on, the Python script resulting from Dump Python operation will include commands related to the publication of the data in the study (if this option is supported by specific module).
55 - **Multi file python dump** - allows to generate multiple files (separately for each component) for dumping of a study to a python script. If the option is disabled, the study is dumped to a single python script.
56 - **Save GUI state in python dump** - if this option is switched on, the Python script resulting from Dump Python operation will include commands related to the GUI state.
58 - **External browser** - allows to define what browser will be used to show SALOME reference manuals: internal (built-in SALOME browser) or external (IE, Netscape, Mozilla, ...). In addition, it is possible to specify
60 - **Application** - this option allows you to set an external browser (IE, Netscape) which will be used for viewing SALOME reference manuals. By default, Mozilla is used.
61 - **Parameters** - additional parameters required for launching of the external browser (if applicable).
65 - **Font** - allows quickly setting the parameters (style, size, face) of the :ref:`font_color_dlg` used in embedded Python console.
66 - **Show banner** - this option allows to show/hide the Python banner on top of the console window.
68 - **Show MRU items** - allows to define the maximum **Number** of items in **Most Recently Used** list and the **Link type**:
70 - **Long** - shows the full path to the file.
71 - **Short** - shows the file name only.
72 - **Auto** - shows full paths to the files only if some files from different locations have the same name.
76 - **Hide object browser and viewers toolbars** - switches automatic hiding of Object Browser and OCC viewer toolbar in full-screen mode.
81 .. image:: ../images/pref_salome_3dviewer.png
84 - **Navigation style** - this option allows to choose one of the modes of work with mouse in OCC and VTK 3D viewers.
86 - **Salome Standard Controls** - allows to manipulate objects in the viewer with the mouse and locked Ctrl button: increase or decrease the zoom ratio with the left mouse button, translate object in any direction with the central mouse button or rotate it with the right mouse button.
87 - **Keyboard Free** - allows to manipulate objects in the viewer with the mouse without locking Ctrl button. In this case the operations are assigned to the buttons differently: rotation is made with the left button, translation with the right and zoom with both pressed in the same time.
89 - **Zooming style** - this option allows to choose a zooming mode.
91 - **Relative to the view's center** - allows to zoom the view relatively to its center.
92 - **Relative to the cursor** - allows to zoom the view relatively to the current cursor position.
94 - **Trihedron** - viewer trihedron settings:
96 - **Size** - size of the coordinate axes (global trihedron) displayed in the viewer.
97 - **Relative** - if this option is switched on, trihedron axes scale to fit the size of the scene displayed in 3D viewer.
98 - **Show static trihedron** - allows to show/hide the static mini-trihedron located in the bottom-left corner of the viewer.
102 OCC 3D Viewer Preferences
103 #########################
105 .. image:: ../images/pref_salome_occviewer.png
108 - **Projection mode** - sets the default projection mode for the viewers: Orthogonal or Perpective.
109 - **Stereo render** - stereoscopic view settings:
111 - **Stereo type** - specifies a stereo pair type:
113 - Shutter glasses (OpenGL quad-buffer)
117 - Chess-board stereo for DLP TVs
118 - Horizontal-anamorphic (side-by-side)
119 - Vertical-anamorphic (Half OverUnder)
122 The stereo pair type selected in this combobox is applied for all existing OCC 3D views with stereo rendering already turned on within the same SALOME GUI session. It is not possible to use different stereo modes in several OCC 3D views at the same time within the same SALOME GUI session.
124 - **Anaglyph filter** - specifies the format of anaglyph stereo pair:
130 - **Convergence distance type**: Absolute or Relative (default).
131 - **Stereographic focus value** - 1 by default.
132 - **IOD type** - Absolute or Relative (default).
133 - **Interocular distance (IOD) value** - 0.05 by default.
134 - **Reverse stereo** - option to swap left and right frames.
135 - **Enable V-Sync** - activates vertical synchronization.
136 - **Enable quad-buffer support** - allows quad-buffered rendering.
139 It is neccessary to enable quad-buffered stereoscopic rendering manually in graphic driver settings. SALOME does not do it automatically.
142 All existing OCC 3D views should be re-created for quad-buffer support.
144 - **Background** - specifies the default background for the viewers, separately for (for more details, refer to the :ref:`viewer_background` page"):
153 - **Enable preselection** - switches preselection on/off.
154 - **Enable selection** - switches selection on/off.
155 - **Advanced selection** - switches default advanced selection style by Polygon or by Circle.
157 - **Clipping parameters** - specifies the default clipping plane parameters.
159 - **Use color of clipped object** - allows to use the color of the clipped object in its clipped region.
160 - **Color** - allows to change the color of the entire clipped region (only used, if "Use color of clipped object" is switched off).
163 Any of the above colors is only used, if "Modulate" is switched on and either "Use default texture" is checked or any texture with "non-black" pixels is given.
165 - **Use default texture** - if this option is switched on, the default texture will be used for clipping texture, otherwise - the texture specified in "Texture" field.
166 - **Texture** - allows to change the texture of the clipped region (enable if "Use default texture" is switched off).
169 If "Use default texture" is switched off and no texture is given, the clipping region will be black. If you want the clipping region to be colored, provide a small white texture image, e.g. 8x8 pixels, and check the "Modulate" option.
171 - **Modulate** - controls if "Texture" should be mixed with "Color" parameter or not.
172 - **Scale factor** - sets the scale factor for default and custom textures.
174 - **Ray tracing** - specifies the default GPU ray-tracing parameters.
176 - **Depth** - defines maximum ray-tracing depth.
177 - **Specular reflections** - enables/disables specular reflections.
178 - **Adaptive anti-aliasing** - enables/disables adaptive anti-aliasing.
179 - **Shadows rendering** - enables/disables shadows rendering.
180 - **Transparent shadow** - enables/disables light propagation through transparent media.
182 - **Light source** - allows to set default parameters for directional light source.
184 - **Color** - allows to change the color of light source.
185 - **Dx, Dy, Dz** - sets direction coordinates.
187 - **Navigation Cube** - allows to manage parameters of navigation cube.
189 - **Show navigation cube on start** - if checked, navigation cube will appear in a new occ viewer.
190 - **Animation duration (sec)** - duration of animation of camera rotation.
191 - **Customize navigation cube appearance** - if checked, below defined parameters will be used instead of default ones.
192 - **Cube color** - color of the navigation cube.
193 - **Text color** - color of text on the navigation cube faces.
194 - **Cube size** - size of the navigation cube.
195 - **Show navigation cube axes** - show navigation cube own axes.
199 VTK 3D Viewer Preferences
200 #########################
202 .. image:: ../images/pref_salome_vtkviewer.png
205 - **Projection mode** - allows choosing between **Orthogonal** and **Perspective** projection mode.
206 - **Background** - specifies the default background for the viewer; for more details, refer to the :ref:`viewer_background`.
207 - **Speed Increment** - defines the number of units by which the speed increases or respectively decreases after pressing [+] or [-] keyboard buttons.
208 - **Modification Mode** - allows choosing between **Arithmetic** and **Geometrical** progression used for zooming.
209 - **Stereo render** - stereoscopic view settings:
211 - **Stereo type** - specifies a stereo pair type:
221 - Split View Port Horizontal
224 The stereo pair type selected in this combobox is applied for all existing VTK 3D views with stereo rendering already turned on within the same SALOME GUI session. It is not possible to use different stereo modes in several VTK 3D views at the same time within the same SALOME GUI session.
226 - **Anaglyph filter** - specifies the format of anaglyph stereo pair:
232 - **Enable quad-buffer support** - allows quad-buffered rendering.
235 It is neccessary to enable quad-buffered stereoscopic rendering manually in graphic driver settings. SALOME does not do it automatically.
237 All existing VTK 3D views should be re-created for quad-buffer support.
241 - **Preselection** - allows to choose among three possible preselection modes:
243 - **Standard** - this mode works quickly, by checking only bounding boxes of objects. It does not deal with the order of actors in the view or with their data (points/ cells).
244 - **Dynamic** - works directly with cells of actors, which provides the exact area of preselection. This mode is much more slower.
245 - **Disabled** - switches off the preselection.
247 - **Enable selection** - switches selection on/off.
249 - **Spacemouse** - a mouse-like manipulator device specially designed for working with 3D presentations, objects, etc. You can reassign the actions listed below to any of its buttons.
251 - **Decrease Speed Increment** - decreases by 1 the speed increment used for the keyboard (same as [-] key).
252 - **Increase Speed Increment** - increase by 1 the speed increment used for the keyboard (same as [+] key).
253 - **Dominant / combined switch** - toggles button to switch to dominant or combined movements.
257 - **Mode** - allows to choose from two recording regimes:
259 - **Recording all displayed frames** - records exactly at the FPS rate specified by the user.
260 - **Recording at a given FPS** - records only when the contents of the viewer change (some activity is performed). In the AVI file non-recorded images are substituted with the copies of the latest recorded image, which produces files with lower quality but requires less system resources.
262 - **FPS** - allows to define the FPS (frames per second) rate for the clip. Set greater value for better quality.
263 - **Quality** - allows to set the quality of the clip in the interval between 0 and 100.
264 - **Progressive** - allows to record a progressive API file.
266 - **Names of groups** - allows to specify parameters of the titles displayed in the viewer:
268 - **Text color** - allows selecting the text color;
269 - **Transparency** - allows selecting the text transparency.
271 .. _plot2d_preferences:
273 Plot 2D Viewer Preferences
274 ##########################
277 .. image:: ../images/pref_salome_plot2dviewer.png
280 - **Background color** - this submenu allows to select the background color. Click on the colored line to access to the :ref:`select_color_and_font_page` dialog box.
281 - **Selection color** - this submenu allows to select the color of selected object in the viewer.
282 - **Viewer** - allows specifying the properties of the Plot 2D Viewer.
284 - **Curve Type** - this allows to set the representation of graphs in your presentations. You can see only **Points**, points connected with **Lines** or points connected with smooth **Splines**.
285 - **Marker Size** - this submenu allows you to set the size of markers in your graphs.
286 - **Horizontal** and **Vertical axis scale** - this submenus allow you to set the scale for vertical and horizontal axes. It can be either **Linear** or **Logarithmic**. Note that the **Logarithmic** scale can be used only if the minimum value of corresponding component (abscissa or ordinate) of all points displayed in the viewer is greater than zero. If this condition is not met, the scale is switched to **Linear** automatically, even if it is set to **Logarithmic**.
287 - **Deviation marker color** - this submenu allows to select the color of the deviation marker.
288 - **Deviation marker line width** allows to define line width of the deviation marker.
289 - **Deviation marker tick size** allows to define size of the upper and lower horizontal lines of the deviation marker.
291 - **Legend** - allows specifying the properties of the legend.
293 - **Show legend** - this options specifies if it's necessary to show legend by default.
294 - **Legend Position** - this submenu allows to set the default position of the legend, it can be located to the left, to the right, on top or on bottom of the graph.
295 - **Symbol type** you can select the type of legend item symbol from "Marker on line" or "Marker above line"
296 - **Legend font** - this allows to set type and face for the font of Legend item.
297 - **Legend font color** - this allows to select the color of the font of the legend item.
298 - **Highlighted legend font color** - this submenu allows to select the color of the font of the selected legend item.
300 .. _default_python_preferences:
302 Python Viewer Preferences
303 #########################
305 .. image:: ../images/pref_salome_pythonviewer.png
309 The following settings are default and will be applied only for newly created Python viewers. Customization of already opened viewers can be done using local :ref:`custom_python_preferences` called by clicking on the corresponding icon of :ref:`python_viewer_page`.
311 - **Font settings** allows setting font variant, size and style.
312 - **Display settings** specifies the script representation in the viewer:
314 - **Enable current line highlight** switches on background coloring of the current line.
315 - **Enable text wrapping** wraps lines at the view border of the editor.
316 - **Center cursor on scroll** scrolls the script vertically to make the cursor visible at the center of the viewer.
317 - **Display line numbers area** shows a panel with line numbers of the script at the left border of the editor.
319 - **Tab settings** allows displaying tab indentation as a certain number of white-spaces.
320 - **Vertical edge settings** manages drawing of a vertical line at the specified column of the viewer.
322 Directories Preferences
323 #######################
325 .. image:: ../images/pref_salome_directories.png
328 - **Quick Directory List** - this section allows to create and manage a custom quick directory list. To add a directory in the list, press the "Add directory" button:
330 .. image:: ../images/image70.png
333 then the **"..."** button and browse the data tree for the directory you need.
334 The "Up" and "Down" buttons(see the picture below) help you to sort the directories in the list:
336 .. image:: ../images/image73.png
339 .. image:: ../images/image75.png
342 To remove the selected directory from the list, press the "Delete"
345 .. image:: ../images/image72.png
348 Object Browser Preferences
349 ##########################
351 .. image:: ../images/pref_salome_objbrowser.png
354 - **Search Tool** - specifies behavior of the :ref:`using_find_tool_page`.
356 - **Enable auto-hiding** checkbox - hides the search tool automatically after short perioud of time when it is not used.
360 - **Auto size for "Name" column** - this checkbox enables automatic resizing for the "Name" column.
361 - **Auto size for other columns** - this checkbox enables automatic resizing for the other columns.
362 - **Resize columns on expand item** - this checkbox enables resizing columns on expanding an object browser item.
363 - **Browse to the published object** - this combobox allows to enable automatic browsing to the objects just published to the study (using GUI dialogs only). It means that the object browser will be scrolled to the published objects, make them visible if they are collapsed and select the first of them. Three modes are allowed for activating this feature:
365 - **Never** - automatic browsing is disabled.
366 - **After Apply & Close only** - browsing is activated when the dialog is accepted by **Apply & Close** or **Ok** buttons (or if the objects are published without using a dialog, for example, by clicking a context menu button) and not activated when the **Apply** button is pressed and therefore the dialog remains visible.
367 - **Always** - automatic browsing is always enabled.
369 - **Default columns** - these checkboxes allow to display or hide **Value**, **Entry**, **IOR** and **Reference entry** columns in the Object Browser.
371 Shortcuts Preferences
372 #####################
374 .. image:: ../images/pref_salome_shortcuts.png
377 - **Shortcuts settings** widget allows to define custom shortcuts for various operations. To change keyboard sequence for a certain action - select the action and press the custom keys combination.
380 :ref:`select_color_and_font_page`: "Font and color preferences"
381 are most oftenly used types of user settings.
383 When you change settings (click **OK** or **Apply** button) each module
384 receives the notification about what preferences are changed. You can
385 also click **Defaults** button to restore default preferences or **Close**
386 button to quit the dialog box without any changes.
388 **Import** button allows loading specific user file containing
389 preferences from any location at the computer through a standard
392 .. image:: ../images/import.png
395 The preferences files usually have \*.xml extension. Also,
396 preferences files automatically saved by the application (stored in the
397 ~/.config/salome directory) have no extension and by default start with
398 .SalomeApprc. followed by SALOME version number. Usually there is a
399 separate preferences file for each SALOME version in use. Preferences
400 are saved to the file in the end of the working session and restored
401 at the application start-up.
404 The preferences you set will be default preferences for all **new** objects, but they are not retroactive and do not automatically apply to the existing objects.
411 select_color_and_font.rst
