\r
.. _introduction:\r
\r
-\r
Introduction to SHAPER\r
======================\r
\r
\r
Only points, axis, planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later.\r
:ref:`parameter_usage` can be used both in Partset and any Part.\r
-\r
- \r
+ \r
A new Part can be created as described in :ref:`partPlugin`.\r
\r
Double click or pop-up menu can be used to activate existing document.\r
\r
-\r
Application desktop\r
-------------------\r
\r
- :ref:`toolbar`; \r
- status bar. \r
\r
-.. image:: images/main_window.png\r
+.. figure:: images/main_window.png\r
:align: center\r
\r
-.. centered::\r
Main window of SHAPER module\r
-\r
\r
.. _main_menu:\r
\r
\r
Main menu provides access to all commands of the application.\r
\r
-.. image:: images/main_menu.png\r
+.. figure:: images/main_menu.png\r
:align: center\r
\r
-.. centered::\r
Main menu\r
\r
Main menu includes standard Salome items:\r
- modules toolbar;\r
- SHAPER toolbar.\r
\r
-.. image:: images/toolbar.png\r
+.. figure:: images/toolbar.png\r
:align: center\r
\r
-.. centered::\r
Toolbars\r
\r
SHAPER toolbar duplicates the main menu and provides access to all commands of the application.\r
- Macros. \r
\r
Visibility of SHAPER toolbar sections is managed using *View -> Toolbar* :ref:`main_menu` item or toolbar pop-up menu.\r
- \r
- \r
+\r
.. _doc_windows:\r
\r
Dock windows\r
\r
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.\r
\r
-.. image:: images/popup_menu.png\r
+.. figure:: images/popup_menu.png\r
:align: center\r
\r
-.. centered::\r
Pop-up menu for visibility of windows and toolbars\r
\r
-\r
.. _object_browser: \r
\r
Object browser\r
\r
Documents with branches are shown in Tree View.\r
\r
-.. image:: images/object_browser.png\r
+.. figure:: images/object_browser.png\r
:align: center\r
\r
-.. centered::\r
- Object browser. Partset active\r
-\r
+ **Object browser**: Partset active\r
\r
Partset includes three branches:\r
\r
\r
Each feature, result, construction, group, field, parameter can be renamed using *Rename* pop-up menu command.\r
\r
-.. image:: images/popup_menu_object_browser_feature.png\r
+.. figure:: images/popup_menu_object_browser_feature.png\r
:align: center\r
\r
-.. centered::\r
- Feature pop-up menu\r
+ **Feature** pop-up menu\r
\r
-.. image:: images/popup_menu_object_browser_result.png\r
+.. figure:: images/popup_menu_object_browser_result.png\r
:align: center\r
\r
-.. centered::\r
- Result pop-up menu\r
+ **Result** pop-up menu\r
\r
-.. image:: images/popup_menu_object_browser_construction.png\r
+.. figure:: images/popup_menu_object_browser_construction.png\r
:align: center\r
\r
-.. centered::\r
- Construction pop-up menu\r
+ **Construction** pop-up menu\r
\r
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.\r
\r
Folders can be used to arrange long Tree View for features.\r
\r
-.. image:: images/object_browser_folder.png\r
+.. figure:: images/object_browser_folder.png\r
:align: center\r
\r
-.. centered::\r
- Object browser with folder Dome. Part_1 active\r
+ **Object browser** with folder Dome: Part_1 active\r
\r
*Insert a folder before* pop-up menu command creates a new empty folder before the selected feature. The folder can be renamed.\r
\r
\r
**Clean history** dialog box shows a list of unused features. After confirmation by click **Yes** button unused features are removed.\r
\r
-.. image:: images/clean_history.png\r
+.. figure:: images/clean_history.png\r
:align: center\r
\r
-.. centered::\r
**Clean history** dialog box\r
\r
-\r
*Select result* and *Select parent feature* pop-up menu commands help to navigate along Tree View.\r
\r
-\r
A feature and its result can be deleted using *Delete* pop-up menu command.\r
\r
Note that all features using the removed feature and their results will be removed simultaneously.\r
\r
**Delete feature** dialog box shows the list of features to be removed. After confirmation by click **Yes** button all these features are removed.\r
\r
-\r
-.. image:: images/delete_feature.png\r
+.. figure:: images/delete_feature.png\r
:align: center\r
\r
-.. centered::\r
**Delete feature** dialog box\r
\r
.. _property_panel:\r
Property panel\r
^^^^^^^^^^^^^^\r
\r
+.. |ok_btn| image:: images/button_ok.png\r
+.. |cancel_btn| image:: images/button_cancel.png\r
+.. |help_btn| image:: images/button_help.png\r
+\r
Property panel consists of two parts:\r
\r
- controls a container for input of parameters for the current operation;\r
- buttons panel containing standard buttons:\r
\r
- .. image:: images/button_ok.png\r
- :align: left\r
- **Ok/Apply** executes operation with defined parameters,\r
-\r
-\r
- .. image:: images/button_cancel.png\r
- :align: left\r
- **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, \r
-\r
- .. image:: images/button_help.png\r
- :align: left\r
- **Help** calls User's guide opened on page describing the current operation.\r
-\r
-.. image:: images/abort_operation.png\r
- :align: center\r
-\r
-.. centered::\r
- **Abort operation** dialog box\r
+ | |ok_btn| **Ok/Apply** executes operation with defined parameters,\r
+ | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, \r
+ | |help_btn| **Help** calls User's guide opened on page describing the current operation.\r
\r
+ .. figure:: images/abort_operation.png\r
+ :align: center\r
+ \r
+ **Abort operation** dialog box\r
\r
-.. image:: images/button_ok.png\r
- :align: left\r
-**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.\r
+|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.\r
\r
.. _inspection_panel: \r
\r
\r
Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, construction or feature.\r
\r
-.. image:: images/inspection_panel.png\r
+.. figure:: images/inspection_panel.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for default Box\r
+ **Inspection panel** for default Box\r
\r
**Object** displays name of the selected result, construction or feature.\r
\r
\r
The information about Point, Axis or Edge additionally shows coordinates of point / end points.\r
\r
-.. image:: images/inspection_panel_line.png\r
+.. figure:: images/inspection_panel_line.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for Axis\r
+ **Inspection panel** for Axis\r
\r
-\r
The information about Plane, Face additionally shows coordinates of center point and direction of normal.\r
\r
-.. image:: images/inspection_panel_face.png\r
+.. figure:: images/inspection_panel_face.png\r
:align: center\r
\r
-.. centered::\r
- Inspection panel for Face \r
+ **Inspection panel** for Face \r
\r
.. _hidefaces_panel:\r
\r
\r
**Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following:\r
\r
-.. image:: images/hide_faces_panel.png\r
+.. figure:: images/hide_faces_panel.png\r
:align: center\r
\r
-.. centered::\r
- Hide Faces panel\r
+ **Hide Faces** panel\r
\r
- If this panel is activated it "listens" user selection.\r
- If a face is selected then its name will be shown in the panel's list and hidden in the viewer. \r
Also it is possible do 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.\r
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.\r
\r
-\r
.. _python console:\r
\r
Python console\r
- Dump commands from console into the specified file;\r
- Start/Stop writing log into the specified file. \r
\r
-\r
-.. image:: images/python_console_popup.png\r
+.. figure:: images/python_console_popup.png\r
:align: center\r
\r
-.. centered::\r
Pop-up menu of Python console\r
\r
.. _viewer:\r
\r
This point of view can be modified using viewer commands: **Panning**, **Zooming**, **Scaling**, etc.\r
\r
-\r
-.. image:: images/2_viewers.png\r
+.. figure:: images/2_viewers.png\r
:align: center\r
\r
-.. centered::\r
Two view windows\r
\r
The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
\r
-\r
.. _parameter_usage:\r
\r
Parameters \r
\r
The list of features using parameters is given in **Parameters** dialog box:\r
\r
- .. image:: images/parameters_feature.png\r
+ .. figure:: images/parameters_feature.png\r
:align: center\r
\r
-.. centered::\r
Parameters dialog box\r
\r
If a parameter value is changed, then all features where it is used are rebuilt.\r
\r
In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted. \r
\r
-.. image:: images/delete_parameter.png\r
+.. figure:: images/delete_parameter.png\r
:align: center\r
\r
-.. centered::\r
Delete parameter\r
\r
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.\r
\r
This tab defines presentation of objects displayed in OCC 3D viewer.\r
\r
-.. image:: images/visualization_preferences.png\r
+.. figure:: images/visualization_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Visualization tab\r
+ **Preferences**: Visualization tab\r
\r
**Input fields**:\r
\r
\r
To redefine any color click on the corresponding line to access **Select color** dialog box\r
\r
-.. image:: images/select_color.png\r
+.. figure:: images/select_color.png\r
:align: center\r
\r
-.. centered::\r
- **Select color** dialog box\r
+ **Preferences**: **Select color** dialog box\r
\r
Preferences for sketch are applicable during sketch creation/edition operation.\r
\r
^^^^^^^^^^^\r
Plugins tab defines folders where plugins and resources are located.\r
\r
-.. image:: images/plugins_preferences.png\r
+.. figure:: images/plugins_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Plugins tab\r
+ **Preferences**: Plugins tab\r
\r
**Input fields**:\r
\r
\r
- **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.\r
\r
-.. image:: images/open_button.png\r
+.. figure:: images/open_button.png\r
:align: center\r
\r
-.. centered::\r
**Open** button\r
\r
-.. image:: images/find_directory.png\r
+.. figure:: images/find_directory.png\r
:align: center\r
\r
-.. centered::\r
**Find directory** dialog box\r
\r
\r
\r
Shortcuts tab defines shortcut keys for different operations.\r
\r
-.. image:: images/shortcuts_preferences.png\r
+.. figure:: images/shortcuts_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Shortcuts tab\r
+ **Preferences**: Shortcuts tab\r
\r
- **Add parameter in parameters manager dialog** defines shortcut keys for adding parameter in parameters manager dialog box.\r
\r
\r
Windows tab contains definitions for the module windows management.\r
\r
-.. image:: images/windows_preferences.png\r
+.. figure:: images/windows_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Windows tab\r
+ **Preferences**: Windows tab\r
\r
- **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.\r
\r
\r
Sketch tab defines properties of coordinate planes shown for selection of sketch plane when no convenient objects are shown in OCC 3D viewer.\r
\r
-.. image:: images/sketch_preferences.png\r
+.. figure:: images/sketch_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Sketch tab\r
+ **Preferences**: Sketch tab\r
\r
**Input fields**:\r
\r
- **Default spline weight** defines default weight for B-spline nodes during creation. The default value can be changed by editing of the spline;\r
- **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation.\r
- **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;\r
-\r
\r
.. _viewer_preferences:\r
\r
\r
Viewer tab defines selection in OCC 3D viewer properties. \r
\r
-.. image:: images/viewer_preferences.png\r
+.. figure:: images/viewer_preferences.png\r
:align: center\r
\r
-.. centered::\r
- Preferences - Viewer tab \r
+ **Preferences**: Viewer tab \r
\r
**Input fields**:\r
\r
- **Vertex** defines selection sensitivity for vertices; \r
- **Edge** defines selection sensitivity for edges. \r
\r
-\r
.. _toolbars_management:\r
\r
Toolbars management\r
To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item. \r
The following dialog box with existing toolbars appears:\r
\r
-.. image:: images/Toolbars.png\r
+.. figure:: images/Toolbars.png\r
:align: center\r
\r
-.. centered::\r
**Toolbars** dialog box\r
\r
**Input fields**:\r
- **OK** button closes the dialog box, stores result of tool bars edition and updates Shaper tool bars;\r
- **Cancel** button closes the dialog box without modification of tool bars.\r
\r
-.. image:: images/delete_toolbar.png\r
+.. figure:: images/delete_toolbar.png\r
:align: center\r
\r
-.. centered::\r
- Warning dialog box\r
-\r
+ Warning dialog box\r
\r
.. _create_toolbar:\r
\r
\r
**Input fields** of **Create toolbar** dialog box:\r
\r
-.. image:: images/create_toolbar.png\r
+.. figure:: images/create_toolbar.png\r
:align: center\r
\r
-.. centered::\r
**Create toolbar** dialog box\r
\r
- **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;\r
- **Ok** button closes the dialog box and add a new tool bar of the module into **Toolbars** window;\r
- **Cancel** button closes the dialog box without addition of a new tool bar.\r
\r
-.. image:: images/name_toolbar.png\r
+.. figure:: images/name_toolbar.png\r
:align: center\r
\r
-.. centered::\r
**Warning** dialog box\r
- \r
\r
.. _edit_toolbar:\r
\r
\r
**Input fields** of **Edit toolbar** dialog box:\r
\r
-.. image:: images/EditToolbar.png\r
+.. figure:: images/EditToolbar.png\r
:align: center\r
\r
-.. centered::\r
**Edit toolbar** dialog box\r
\r
- **Toolbar name** non-editable field displays name of modified tool bar;\r
- **Up** and **Down** buttons change position of selected command in **In the toolbar** window;\r
- **Ok** button closes the dialog box, stores result of edition;\r
- **Cancel** button closes the dialog box without modification of tool bar content.\r
-\r
-\r
