7 SHAPER module of SALOME is destined for:
9 - import and export of geometrical models in IGES, BREP, STEP and XAO formats;
10 - parametric construction of geometrical objects using a wide range of functions:
12 - creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution (see :ref:`featuresPlugin`);
13 - construction of model using primitives defined in :ref:`primitivesPlugin`;
14 - usage of Boolean operations (see :ref:`featuresPlugin`);
16 - viewing geometrical objects in the OCC viewer;
17 - transformation of geometrical objects using various algorithms.
19 It is possible to easily set :ref:`parameter_usage` predefined to be used as arguments when objects are created.
21 SHAPER module preferences are described in the :ref:`preferences` section of SALOME Help.
23 Almost all SHAPER module functionalities are accessible via Python Interface.
25 SHAPER module works with one study containing several documents:
28 - one or several parts.
30 Only one document can be active. In complicated models partset consists of several parts. Parts in partset may be copied, positioned relatively to each other, or simply translated.
32 A new study contains only a partset with 7 default constructions, which cannot be deleted:
34 - one point **Origin** coinciding with the origin of the coordinate system;
35 - three axes **OX**, **OY**, **OZ** coinciding with coordinate axes;
36 - three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes.
38 Only points, axis, planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later.
39 :ref:`parameter_usage` can be used both in Partset and any Part.
41 A new Part can be created as described in :ref:`partPlugin`.
43 Double click or pop-up menu can be used to activate existing document.
48 The main window of the application consists of the following components:
56 .. figure:: /images/main_window.png
59 Main window of SHAPER module
66 Main menu provides access to all commands of the application.
68 .. figure:: /images/main_menu.png
73 Main menu includes standard Salome items:
82 and items specific for SHAPER module:
84 - Part (see :ref:`partPlugin`);
85 - Sketch (see :ref:`sketchPlugin`);
86 - Construction (see :ref:`constructionPlugin`);
87 - Build (see :ref:`buildPlugin`);
88 - Primitives (see :ref:`primitivesPlugin`);
89 - Features (see :ref:`featuresPlugin`);
97 Application toolbar contains:
103 .. figure:: /images/toolbar.png
108 SHAPER toolbar duplicates the main menu and provides access to all commands of the application.
110 SHAPER toolbar is separated into sections:
126 Visibility of SHAPER toolbar sections is managed using *View -> Toolbar* :ref:`main_menu` item or toolbar pop-up menu.
133 Standard dock windows are:
135 - :ref:`object_browser`
136 - :ref:`inspection_panel`
137 - :ref:`hidefaces_panel`
138 - :ref:`python console`
139 - :ref:`property_panel`
141 Dock windows can be placed in three dock areas using drag-and-drop:
147 By default Object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window.
149 Property Panel is hidden.
151 Property Panel is shown on operation start in left dock area of the main window by default.
153 If Object browser is shown at the same side then they will be tabbed.
155 Each dock window can be closed using **Cross** window button and opened again using a corresponding command from *View - Windows* :ref:`main_menu` or alternatively using pop-up menu.
157 .. figure:: /images/popup_menu.png
160 Pop-up menu for visibility of windows and toolbars
167 Object browser contains all documents created in the current study.
169 Each document includes standard branches where created objects are placed.
171 Documents with branches are shown in Tree View.
173 .. figure:: /images/object_browser.png
176 **Object browser**: Partset active
178 Partset includes three branches:
184 Part includes the following branches:
193 New part contains only 3 empty branches:
199 Features are placed one after another in the active document with default names and their results are placed into the corresponding branch.
201 Examples of default names assigned automatically for :ref:`box_feature` are:
203 * **Box_1**, **Box_2**, ... for Feature;
204 * **Box_1_1**, **Box_2_1**, ... for Result.
206 Note, that a default branch is added into Tree View when the first feature of this type is created.
208 Note, that the result used in feature as argument is removed.
210 This child result can be restored using **Recover** feature.
212 Each feature, result, construction, group, field, parameter can be renamed using *Rename* pop-up menu command (hotkey "F2").
214 .. figure:: /images/popup_menu_object_browser_feature.png
217 **Feature** pop-up menu
219 .. figure:: /images/popup_menu_object_browser_result.png
222 **Result** pop-up menu
224 .. figure:: /images/popup_menu_object_browser_construction.png
227 **Construction** pop-up menu
229 .. figure:: /images/popup_menu_object_browser_group.png
232 **Group** pop-up menu
234 The order of features can be changed using *Move to the end* and *Move to the end and split* pop-up menu commands. They work only for Group features. The selected group or several groups will be moved to the end of features list. The *Move to the end and split* also splits the resulting group in several groups: one group per one selection.
236 Folders can be used to arrange long Tree View for features.
238 .. figure:: /images/object_browser_folder.png
241 **Object browser** with folder Dome: Part_1 active
243 *Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. The folder can be renamed.
245 Features placed after/before the created folder can be moved into the folder using *Move into the previous folder* / *Move into the next folder* pop-up menu command.
247 This allows to decrease the length of feature list.
249 Features can be removed from the folder using *Move out before the folder* / *Move out after the folder* pop-up menu command.
251 *Clean history* pop-up menu command looks for features that do not participate in other features.
253 **Clean history** dialog box shows a list of unused features. After confirmation by click **Yes** button unused features are removed.
255 .. figure:: /images/clean_history.png
258 **Clean history** dialog box
260 *Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View.
262 A feature and its result can be deleted using *Delete* pop-up menu command.
264 Note that all features using the removed feature and their results will be removed simultaneously.
266 **Delete feature** dialog box shows the list of features to be removed. After confirmation by click **Yes** button all these features are removed.
268 .. figure:: /images/delete_feature.png
271 **Delete feature** dialog box
278 .. |ok_btn| image:: /images/button_ok.png
279 .. |cancel_btn| image:: /images/button_cancel.png
280 .. |help_btn| image:: /images/button_help.png
282 Property panel consists of two parts:
284 - controls a container for input of parameters for the current operation;
285 - buttons panel containing standard buttons:
287 | |ok_btn| **Ok/Apply** executes operation with defined parameters,
288 | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort,
289 | |help_btn| **Help** calls User's guide opened on page describing the current operation.
291 .. figure:: /images/abort_operation.png
294 **Abort operation** dialog box
296 |ok_btn| **OK/Apply** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar.
298 .. _inspection_panel:
303 Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, construction or feature.
305 .. figure:: /images/inspection_panel.png
308 **Inspection panel** for default Box
310 **Object** displays name of the selected result, construction or feature.
312 **Type** characterizes the whole shape.
314 The information about Point, Axis or Edge additionally shows coordinates of point / end points.
316 .. figure:: /images/inspection_panel_line.png
319 **Inspection panel** for Axis
321 The information about Plane, Face additionally shows coordinates of center point and direction of normal.
323 .. figure:: /images/inspection_panel_face.png
326 **Inspection panel** for Face
328 The shapes information, equal to the provided Inspection panel information on the shape is accessible inpython API by usage of **shapeInfo** command:
330 | *from salome.shaper import geom*
331 | *geom.shapeInfo(vertex)*
332 | *==> ('Vertex', 0.0, 0.0, 10.0)*
340 **Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following:
342 .. figure:: /images/hide_faces_panel.png
347 - If this panel is activated it "listens" user selection.
348 - If a face is selected then its name will be shown in the panel's list and hidden in the viewer.
349 - If user selects a group of faces (or at least a one face of this group) then whole group will be hidden and also all faces from all objects referenced by this group.
350 - If user will display the hidden group again (by a show operation) then the group will be removed from Hide Faces list and visibility of all referenced faces will be restored.
352 It is also possible not to hide faces, but make them transparent. For this purpose **"Transparent"** check-box can be used. Value of the transparency can be changed in **Visualization** tab of **Preferences** dialog box.
353 Closing of **Hide Faces** panel restores visibility state of all objects. If it is necessary to deactivete the **Hide Faces** panel (preserving the current display state) then user has to press **"Esc"** button.
360 Python console interpreters Python commands entered manually.
362 In particular, it is possible to load the python script:
364 *execfile(r"/dn48/newgeom/data/example.py")*
366 Pop-up menu gives the possibility to:
368 - Copy the selected text to clipboard;
369 - Paste the text from clipboard to Python console ;
370 - Clear Python console;
371 - Dump commands from console into the specified file;
372 - Start/Stop writing log into the specified file.
374 .. figure:: /images/python_console_popup.png
377 Pop-up menu of Python console
384 The application supports one instance of OCC 3D viewer and is able to show only one 3D space.
386 This 3D space can be represented in several view windows. New view window can be created using **Clone view** button in viewer toolbar.
388 Each view windows shows its own point of view on the 3D scene.
390 This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc.
392 .. figure:: /images/2_viewers.png
397 The viewer is able to show direction of edges of objects.
399 .. figure:: /images/edges_directions.png
402 Showing the edges direction
404 The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.
411 Model parametrization can be done using parameters.
413 A parameter can be created in the active partset or part by:
417 - :ref:`parameter_expression`.
419 Any argument in features can be defined as parameter or expression containing parameters.
421 The list of features using parameters is given in **Parameters** dialog box:
423 .. figure:: /images/parameters_feature.png
426 Parameters dialog box
428 If a parameter value is changed, then all features where it is used are rebuilt.
430 A parameter name should be unique in the active document.
432 However, partset and part can have parameters with the same name. If parameter names in Partset and Part are identical, then Part parameter has a higher priority and its value will be used in the features of this part.
434 In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted.
436 .. figure:: /images/delete_parameter.png
441 After clicking **Replace** button, the selected parameter is removed but its parent parameters and features are not removed. The deleted parameter is replaced by its value.
443 .. _parameter_expression:
445 Create parameter on fly
446 ^^^^^^^^^^^^^^^^^^^^^^^
448 Parameter can be created during feature creation simply by writing *variable=expression* in any editbox.
450 After feature validation a new parameter with the given name **variable** and value equal to the evaluated expression appears in object browser under **Parameters** in the active partset or part.
457 Description of General application preferences and **Preferences** dialog box is provided in GUI module user's guide in chapter **Setting Preferences**.
459 SHAPER preferences define visualization of objects, visualization during selection, edition. New preferences can be used right after modification or later after activation of SHAPER module.
461 To call **Preferences** dialog box:
463 #. select in the Main Menu *File - > Preferences* item or
464 #. use **Ctrl+P** shortcut.
466 SHAPER preferences contains the following tabs:
468 - :ref:`general_preferences`;
469 - :ref:`visualization_preferences`;
470 - :ref:`plugins_preferences`;
471 - :ref:`shortcuts_preferences`;
472 - :ref:`windows_preferences`.
473 - :ref:`sketch_preferences`.
474 - :ref:`viewer_preferences`.
476 General tab is activated by default when **Preferences** dialog box is opened in the active SHAPER module.
478 Other tabs are activated by click on tab header.
480 .. _general_preferences:
485 This tab defines behavior of Parts and displayed objects on creation or opening of a study, or loading python scripts.
487 .. figure:: /images/general_preferences.png
490 **Preferences**: General tab
494 - **Create new part** flag. If it is enabled, an empty part is created on a study creation.
496 - **Activate** relates to activation of part when opening a HDF document. Its could be one of the following:
498 - "Last part" - activate last part in the document (**default value**);
499 - "All parts" - activate all parts within the document;
500 - "No activation" - do not activate any part.
502 - **Display** in "Opening a study". It specifies the shapes, which should be visualized when activating a part. It could be one of the following:
504 - "As stored in HDF" - display only the shapes visible before the document is saved (**default value**);
505 - "Last item in each folder" - show only the last result in each folder of the part: Constructions, Results, Groups, Fields;
506 - "All items" - show all shapes from each folder;
507 - "No visualization" - do not display any shape.
509 - **Display** in "Launching a python script". It specifies the shapes, which should be visualized when loading a script using "File -> Load Script..." menu. It could be one of the following:
511 - "Last item in each folder" - show only the last result in each folder of the part: Constructions, Results, Groups, Fields;
512 - "All items" - show all shapes from each folder(**default value**);
513 - "No visualization" - do not display any shape.
515 .. _visualization_preferences:
520 This tab defines presentation of objects displayed in OCC 3D viewer.
522 .. figure:: /images/visualization_preferences.png
525 **Preferences**: Visualization tab
529 - **Selection color** defines a color for selected objects;
530 - **Result color** selects default shading color for objects from **Results** branch;
531 - **Group color** selects default color for objects from **Groups** branch;
532 - **Construction color** selects default color for objects from **Constructions** branch;
533 - **Part color** selects default color for parts shown in Partset;
534 - **Field color** selects default color for objects from **Fields** branch;
535 - **Body deflection coefficient** defines default deflection coefficient for objects from **Results** branch. A smaller coefficient provides better quality of a shape in the viewer;
536 - **Construction deflection coefficient** defines default deflection coefficient for objects from **Constructions** branch. A smaller coefficient provides better quality of a shape in the viewer;
537 - **Reference shape wireframe color in operation** selects default color used for wireframe visualization of objects used in active operation;
538 - **Result shape wireframe color in operation** selects default color used for wireframe visualization of result in active operation. Click **See preview** button to show result;
539 - **Multi selector item color in operation** selects default color used for visualization of objects selected in property panel to distinguish them among all objects used in active operation;
540 - **Color of removed feature in operation** selects default color used for visualization of sketch entities to be removed during **Trim/Split** operations;
541 - **Color of sketch plane** selects default shading color for sketch plane;
542 - **Hidden faces transparency** defines default transparency value for hidden faces;
543 - **Dimension arrow size** defines default size of arrows for extension line showing dimensional constraint;
544 - **Dimension font** defines font used for value of dimensional constraint;
545 - **Dimension value size** defines default size of value for dimensional constraint;
546 - **Sketch dimension color** defines default color of dimensional constraint;
547 - **Construction plane color** selects default color for Construction planes;
548 - **Sketch entity color** selects default color for sketch objects;
549 - **Sketch external entity color** selects default color for external objects selected as reference during sketch creation/edition;
550 - **Sketch auxiliary entity color** selects default color for sketch auxiliary objects;
551 - **Sketch overconstraint color** selects default color for a sketch with redundant constraints;
552 - **Sketch fully constraint color** selects default color for a sketch with zero degrees of freedom.
553 - **Zoom trihedron arrows** if this control is checked then arrows of a view trihedron will be scaled according to current view scale
554 - **Axis arrow size** relative size of trihedron arrows. It has effect only in case if **Zoom trihedron arrows** is On.
556 To redefine any color click on the corresponding line to access **Select color** dialog box
558 .. figure:: /images/select_color.png
561 **Preferences**: **Select color** dialog box
563 Preferences for sketch are applicable during sketch creation/edition operation.
565 .. _plugins_preferences:
569 Plugins tab defines folders where plugins and resources are located.
571 .. figure:: /images/plugins_preferences.png
574 **Preferences**: Plugins tab
578 - **Default path** selects default folder where plugins are located. Click on **Open** button opens standard **Find directory** dialog box to navigate to desired folder;
580 - **Import initial directory** selects default folder where resources are located. Click on **Open** button opens standard **Find directory** dialog box to navigate to desired folder.
582 .. figure:: /images/open_button.png
587 .. figure:: /images/find_directory.png
590 **Find directory** dialog box
593 .. _shortcuts_preferences:
598 Shortcuts tab defines shortcut keys for different operations.
600 .. figure:: /images/shortcuts_preferences.png
603 **Preferences**: Shortcuts tab
605 - **Add parameter in parameters manager dialog** defines shortcut keys for adding parameter in parameters manager dialog box.
607 .. _windows_preferences:
612 Windows tab contains definitions for the module windows management.
614 .. figure:: /images/windows_preferences.png
617 **Preferences**: Windows tab
619 - **Use HideFaces panel in operation** if the checkbox is checked then HideFaces panel will be launched automatically on launching an operation where using of this panel is considered.
621 .. _sketch_preferences:
626 Sketch tab defines properties of coordinate planes shown for selection of sketch plane when no convenient objects are shown in OCC 3D viewer.
628 .. figure:: /images/sketch_preferences.png
631 **Preferences**: Sketch tab
635 - **Size** defines size of coordinate planes;
636 - **Thickness** defines thickness of coordinate plane borders;
637 - **Rotate to plane when selected** check-box turns on/off automatic switch the viewer to the top view for the selected sketch plane;
638 - **Angular tolerance** defines defines an angular tolerance for automatic creation of horizontal and vertical constraints;
639 - **Default spline weight** defines default weight for B-spline nodes during creation. The default value can be changed by editing of the spline;
640 - **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation;
641 - **Create sketch entities by dragging** defines a style of sketch etities creation. It concerns creation of lines, rectangles, circles, arcs, ellipses, elliptic arcs. If it is switched ON then points of objects have to be defined by mouse press - mouse move - mouse release. Otherwise every point of an object has to be defined by mouse click;
642 - **Allow automatic constraint substitution/remove** allows automatic resolving of conflicting constraints.
643 The following conflicts could be processed:
644 - Horizontal/Vertical automatic constraints (this last constraint will be removed);
645 - Pair of arcs connected smoothly, which centers are coincident (Tangency between arcs will be removed);
646 - **Notify automatic constraint substitution/remove** defines a message box to be shown to the user, if the conflicting constraints situation is automatically resolved.
648 .. _viewer_preferences:
653 Viewer tab defines selection in OCC 3D viewer properties.
655 .. figure:: /images/viewer_preferences.png
658 **Preferences**: Viewer tab
662 - **Default Selection** defines objects to be selected by mouse click in OCC 3D viewer:
664 - **Faces** check-box turns on/off selection of faces;
665 - **Edges** check-box turns on/off selection of edges;
666 - **Vertices** check-box turns on/off selection of vertices;
668 - **Selection sensitivity** defines size of area around object in pixels, in which mouse click selects object inside this area:
670 - **Vertex** defines selection sensitivity for vertices;
671 - **Edge** defines selection sensitivity for edges.
673 .. _toolbars_management:
680 **Toolbars** dialog box
681 ^^^^^^^^^^^^^^^^^^^^^^^
682 To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item.
683 The following dialog box with existing toolbars appears:
685 .. figure:: /images/Toolbars.png
688 **Toolbars** dialog box
692 - **Toolbars** window contains list of toolbars names. Number of commands in each tool bar is shown in brackets.
693 - **Add** button creates a new toolbar. Click on **Add** button opens :ref:`create_toolbar`;
694 - **Edit** button calls :ref:`edit_toolbar` for currently selected tool bar;
695 - **Delete** button removes currently selected tool bar. Click on **Delete** button opens warning dialog box. After confirmation by click **Yes** button the selected toolbar is deleted. Click **No** button cancels removing of the selected toolbar;
696 - **Reset** button restores modified tool bars structure to default state;
697 - **OK** button closes the dialog box, stores result of tool bars edition and updates Shaper tool bars;
698 - **Cancel** button closes the dialog box without modification of tool bars.
700 .. figure:: /images/delete_toolbar.png
707 **Create toolbar** dialog box
708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
710 **Input fields** of **Create toolbar** dialog box:
712 .. figure:: /images/create_toolbar.png
715 **Create toolbar** dialog box
717 - **Name of a new toolbar** defines name of the new tool bar. The name of tool bar has to be unique. If user defines a not unique name then a warning appears and a new tooolbar with not unique name is not created;
718 - **Ok** button closes the dialog box and add a new tool bar of the module into **Toolbars** window;
719 - **Cancel** button closes the dialog box without addition of a new tool bar.
721 .. figure:: /images/name_toolbar.png
724 **Warning** dialog box
728 **Edit toolbar** dialog box
729 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
731 **Input fields** of **Edit toolbar** dialog box:
733 .. figure:: /images/EditToolbar.png
736 **Edit toolbar** dialog box
738 - **Toolbar name** non-editable field displays name of modified tool bar;
739 - **Out of toolbars** window contains list of commands which are not included into any tool bar and separator definition "------";
740 - **In the toolbar** window contains list of commands which are defined in the current tool bar. Items in this window are listed according to order of commands in the toolbar;
741 - **Right arrow** button transfers currently selected item from **Out of toolbars** window to **In the toolbar** window and puts new item before the selected item in **In the toolbar** window.
742 If there is no selected item in **In the toolbar** window then new item will be added at the end of items list. In order to clear current selection it is necessary to click in empty space of the window.
743 - **Left arrow** button transfers currently selected item from **In the toolbar** window into **Out of toolbars** window;
744 - **Up** and **Down** buttons change position of selected command in **In the toolbar** window;
745 - **Ok** button closes the dialog box, stores result of edition;
746 - **Cancel** button closes the dialog box without modification of tool bar content.