- import and export of geometrical models in IGES, BREP, STEP and XAO formats;
- parametric construction of geometrical objects using a wide range of functions:
-
+
- creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution (see :ref:`featuresPlugin`);
- construction of model using primitives defined in :ref:`primitivesPlugin`;
- usage of Boolean operations (see :ref:`featuresPlugin`);
-
+
- viewing geometrical objects in the OCC viewer;
- transformation of geometrical objects using various algorithms.
- one or several parts.
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.
-
+
A new study contains only a partset with 7 default constructions, which cannot be deleted:
-
+
- one point **Origin** coinciding with the origin of the coordinate system;
- three axes **OX**, **OY**, **OZ** coinciding with coordinate axes;
-- three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes.
+- three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes.
Only points, axis, planes (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added into Partset to be used in any part later.
:ref:`parameter_usage` can be used both in Partset and any Part.
-
+
A new Part can be created as described in :ref:`partPlugin`.
Double click or pop-up menu can be used to activate existing document.
- :ref:`main_menu`;
- :ref:`doc_windows`;
- :ref:`viewer`;
-- :ref:`toolbar`;
-- status bar.
+- :ref:`toolbar`;
+- status bar.
.. figure:: /images/main_window.png
:align: center
Main window of SHAPER module
-
+
.. _main_menu:
-Main menu
+Main menu
---------
Main menu provides access to all commands of the application.
- Tools;
- Window;
- Help;
-
+
and items specific for SHAPER module:
- Part (see :ref:`partPlugin`);
- Construction (see :ref:`constructionPlugin`);
- Build (see :ref:`buildPlugin`);
- Primitives (see :ref:`primitivesPlugin`);
-- Features (see :ref:`featuresPlugin`);
-- Macros.
+- Features (see :ref:`featuresPlugin`);
+- Macros.
.. _toolbar:
Dock windows
------------
-Standard dock windows are:
+Standard dock windows are:
- :ref:`object_browser`
- :ref:`inspection_panel`
- :ref:`property_panel`
Dock windows can be placed in three dock areas using drag-and-drop:
-
-- left,
-- right,
+
+- left,
+- right,
- bottom.
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.
Pop-up menu for visibility of windows and toolbars
-.. _object_browser:
+.. _object_browser:
Object browser
^^^^^^^^^^^^^^
-Object browser contains all documents created in the current study.
+Object browser contains all documents created in the current study.
Each document includes standard branches where created objects are placed.
- Parameters;
- Constructions;
-- Features
+- Features
Part includes the following branches:
- Constructions;
- Results;
- Fields;
-- Groups;
-- Features.
+- Groups;
+- Features.
New part contains only 3 empty branches:
-
+
- Parameters;
- Constructions;
- Results.
Features are placed one after another in the active document with default names and their results are placed into the corresponding branch.
Examples of default names assigned automatically for :ref:`box_feature` are:
-
+
* **Box_1**, **Box_2**, ... for Feature;
* **Box_1_1**, **Box_2_1**, ... for Result.
**Construction** pop-up menu
+.. figure:: /images/popup_menu_object_browser_group.png
+ :align: center
+
+ **Group** pop-up menu
+
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.
Folders can be used to arrange long Tree View for features.
:align: center
**Delete feature** dialog box
-
+
.. _property_panel:
Property panel
- controls a container for input of parameters for the current operation;
- buttons panel containing standard buttons:
-
+
| |ok_btn| **Ok/Apply** executes operation with defined parameters,
- | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort,
+ | |cancel_btn| **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort,
| |help_btn| **Help** calls User's guide opened on page describing the current operation.
.. figure:: /images/abort_operation.png
:align: center
-
+
**Abort operation** dialog box
|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.
-.. _inspection_panel:
+.. _inspection_panel:
-Inspection panel
+Inspection panel
^^^^^^^^^^^^^^^^
Inspection panel provides the list of types and quantities of all topological entities, composing the selected result, construction or feature.
**Object** displays name of the selected result, construction or feature.
**Type** characterizes the whole shape.
-
+
The information about Point, Axis or Edge additionally shows coordinates of point / end points.
.. figure:: /images/inspection_panel_line.png
:align: center
**Inspection panel** for Axis
-
+
The information about Plane, Face additionally shows coordinates of center point and direction of normal.
.. figure:: /images/inspection_panel_face.png
:align: center
- **Inspection panel** for Face
+ **Inspection panel** for Face
+
+The shapes information, equal to the provided Inspection panel information on the shape is accessible inpython API by usage of **shapeInfo** command:
+
+ | *from salome.shaper import geom*
+ | *geom.shapeInfo(vertex)*
+ | *==> ('Vertex', 0.0, 0.0, 10.0)*
+
.. _hidefaces_panel:
Hide Faces panel
^^^^^^^^^^^^^^^^
-**Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following:
+**Hide Faces** panel makes it possible to temporarily hide faces of any displayed object. **Hide Faces** panel looks like following:
.. figure:: /images/hide_faces_panel.png
:align: center
**Hide Faces** panel
-- If this panel is activated it "listens" user selection.
-- If a face is selected then its name will be shown in the panel's list and hidden in the viewer.
-- 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.
-- 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.
+- If this panel is activated it "listens" to the user selection.
+- If a face is selected then its name will be shown in the panel's list and hidden in the viewer.
+- If the user wants to display a hidden result body again (by a show operation) then the faces of this result body will be removed from Hide Faces list and the visibility of all referenced faces will be restored.
-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.
-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.
+Instead of hiding the faces, it is also possible to make them transparent. For this purpose the **"Transparent"** check-box can be used. The value of the transparency can be changed under the **Visualization** tab of the **Preferences** dialog box.
+Closing the **Hide Faces** panel restores the visibility state of all objects. If it is necessary to deactivete the **Hide Faces** panel (preserving the current display state) then the user has to press the **"Esc"** button.
.. _python console:
- Paste the text from clipboard to Python console ;
- Clear Python console;
- Dump commands from console into the specified file;
-- Start/Stop writing log into the specified file.
-
+- Start/Stop writing log into the specified file.
+
.. figure:: /images/python_console_popup.png
:align: center
Two view windows
+The viewer is able to show direction of edges of objects.
+
+.. figure:: /images/edges_directions.png
+ :align: center
+
+ Showing the edges direction
+
The description of OCC 3D Viewer architecture and functionality is provided in GUI module user's guide in chapter **OCC 3D Viewer**.
.. _parameter_usage:
-Parameters
+Parameters
----------
Model parametrization can be done using parameters.
:align: center
Parameters dialog box
-
+
If a parameter value is changed, then all features where it is used are rebuilt.
A parameter name should be unique in the active document.
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.
-In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted.
+In contrast to features (see :ref:`object_browser`), there is an additional option when parameters are deleted.
.. figure:: /images/delete_parameter.png
:align: center
SHAPER preferences contains the following tabs:
+- :ref:`general_preferences`;
- :ref:`visualization_preferences`;
- :ref:`plugins_preferences`;
- :ref:`shortcuts_preferences`;
- :ref:`sketch_preferences`.
- :ref:`viewer_preferences`.
-Visualization tab is activated by default when **Preferences** dialog box is opened in the active SHAPER module.
+General tab is activated by default when **Preferences** dialog box is opened in the active SHAPER module.
Other tabs are activated by click on tab header.
-
+
+.. _general_preferences:
+
+General tab
+^^^^^^^^^^^
+
+This tab defines behavior of Parts and displayed objects on creation or opening of a study, or loading python scripts.
+
+.. figure:: /images/general_preferences.png
+ :align: center
+
+ **Preferences**: General tab
+
+**Input fields**:
+
+- **Create new part** flag. If it is enabled, an empty part is created on a study creation.
+
+- **Activate** relates to activation of part when opening a HDF document. Its could be one of the following:
+
+ - "Last part" - activate last part in the document (**default value**);
+ - "All parts" - activate all parts within the document;
+ - "No activation" - do not activate any part.
+
+- **Display** in "Opening a study". It specifies the shapes, which should be visualized when activating a part. It could be one of the following:
+
+ - "As stored in HDF" - display only the shapes visible before the document is saved (**default value**);
+ - "Last item in each folder" - show only the last result in each folder of the part: Constructions, Results, Groups, Fields;
+ - "All items" - show all shapes from each folder;
+ - "No visualization" - do not display any shape.
+
+- **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:
+
+ - "Last item in each folder" - show only the last result in each folder of the part: Constructions, Results, Groups, Fields;
+ - "All items" - show all shapes from each folder(**default value**);
+ - "No visualization" - do not display any shape.
+
.. _visualization_preferences:
Visualization tab
- **Result color** selects default shading color for objects from **Results** branch;
- **Group color** selects default color for objects from **Groups** branch;
- **Construction color** selects default color for objects from **Constructions** branch;
-- **Part color** selects default color for parts shown in Partset;
+- **Part color** selects default color for parts shown in Partset;
- **Field color** selects default color for objects from **Fields** branch;
- **Body deflection coefficient** defines default deflection coefficient for objects from **Results** branch. A smaller coefficient provides better quality of a shape in the viewer;
- **Construction deflection coefficient** defines default deflection coefficient for objects from **Constructions** branch. A smaller coefficient provides better quality of a shape in the viewer;
- **Color of removed feature in operation** selects default color used for visualization of sketch entities to be removed during **Trim/Split** operations;
- **Color of sketch plane** selects default shading color for sketch plane;
- **Hidden faces transparency** defines default transparency value for hidden faces;
-- **Dimension arrow size** defines default size of arrows for extension line showing dimensional constraint;
+- **Dimension arrow size** defines default size of arrows for extension line showing dimensional constraint;
- **Dimension font** defines font used for value of dimensional constraint;
- **Dimension value size** defines default size of value for dimensional constraint;
-- **Sketch dimension color** defines default color of dimensional constraint;
-- **Construction plane color** selects default color for Construction planes;
+- **Sketch dimension color** defines default color of dimensional constraint;
+- **Construction plane color** selects default color for Construction planes;
- **Sketch entity color** selects default color for sketch objects;
- **Sketch external entity color** selects default color for external objects selected as reference during sketch creation/edition;
- **Sketch auxiliary entity color** selects default color for sketch auxiliary objects;
- **Sketch overconstraint color** selects default color for a sketch with redundant constraints;
- **Sketch fully constraint color** selects default color for a sketch with zero degrees of freedom.
-
+- **Zoom trihedron arrows** if this control is checked then arrows of a view trihedron will be scaled according to current view scale
+- **Axis arrow size** relative size of trihedron arrows. It has effect only in case if **Zoom trihedron arrows** is On.
+- **Enable automatic rotation** enables the perpetual rotation animation in the viewer.
+
To redefine any color click on the corresponding line to access **Select color** dialog box
.. figure:: /images/select_color.png
:align: center
**Preferences**: **Select color** dialog box
-
+
Preferences for sketch are applicable during sketch creation/edition operation.
-
+
.. _plugins_preferences:
-
+
Plugins tab
^^^^^^^^^^^
Plugins tab defines folders where plugins and resources are located.
:align: center
**Find directory** dialog box
-
-
+
+
.. _shortcuts_preferences:
-
+
Shortcuts tab
^^^^^^^^^^^^^
:align: center
**Preferences**: Shortcuts tab
-
+
- **Add parameter in parameters manager dialog** defines shortcut keys for adding parameter in parameters manager dialog box.
-
+
.. _windows_preferences:
Windows tab
**Input fields**:
- **Size** defines size of coordinate planes;
-- **Thickness** defines thickness of coordinate plane borders;
-- **Rotate to plane when selected** check-box turns on/off automatic switch the viewer to the top view for the selected sketch plane.
+- **Thickness** defines thickness of coordinate plane borders;
+- **Rotate to plane when selected** check-box turns on/off automatic switch the viewer to the top view for the selected sketch plane;
- **Angular tolerance** defines defines an angular tolerance for automatic creation of horizontal and vertical constraints;
- **Default spline weight** defines default weight for B-spline nodes during creation. The default value can be changed by editing of the spline;
-- **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation.
+- **Cursor for sketch operation** defines a cursor which indicates a launched sketcher sub-operation;
- **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;
-
+- **Allow automatic constraint substitution/remove** allows automatic resolving of conflicting constraints.
+ The following conflicts could be processed:
+ - Horizontal/Vertical automatic constraints (this last constraint will be removed);
+ - Pair of arcs connected smoothly, which centers are coincident (Tangency between arcs will be removed);
+- **Notify automatic constraint substitution/remove** defines a message box to be shown to the user, if the conflicting constraints situation is automatically resolved.
+
.. _viewer_preferences:
-
+
Viewer tab
^^^^^^^^^^
-Viewer tab defines selection in OCC 3D viewer properties.
+Viewer tab defines selection in OCC 3D viewer properties.
.. figure:: /images/viewer_preferences.png
:align: center
- **Preferences**: Viewer tab
+ **Preferences**: Viewer tab
**Input fields**:
- **Selection sensitivity** defines size of area around object in pixels, in which mouse click selects object inside this area:
- - **Vertex** defines selection sensitivity for vertices;
- - **Edge** defines selection sensitivity for edges.
+ - **Vertex** defines selection sensitivity for vertices;
+ - **Edge** defines selection sensitivity for edges.
.. _toolbars_management:
**Toolbars** dialog box
^^^^^^^^^^^^^^^^^^^^^^^
-To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item.
+To edit the current tool bars structure select in the Main Menu *Edit - > Edit toolbars* item.
The following dialog box with existing toolbars appears:
.. figure:: /images/Toolbars.png
:align: center
Warning dialog box
-
+
.. _create_toolbar:
**Create toolbar** dialog box
- **Toolbar name** non-editable field displays name of modified tool bar;
- **Out of toolbars** window contains list of commands which are not included into any tool bar and separator definition "------";
-- **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;
+- **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;
- **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.
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.
- **Left arrow** button transfers currently selected item from **In the toolbar** window into **Out of toolbars** window;
