Introduction to SHAPER\r
======================\r
\r
+SHAPER module of SALOME is destined for:\r
+\r
+- import and export of geometrical models in IGES, BREP, STEP and XAO formats;\r
+- parametrical construction of geometrical objects using a wide range of functions;\r
+ \r
+ - creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution :ref:`featuresPlugin`;\r
+ - construction of model using primitives defined in :ref:`primitivesPlugin`;\r
+ - usage of Boolean operations :ref:`featuresPlugin`;\r
+ \r
+- viewing geometrical objects in the OCC viewer;\r
+- transformation of geometrical objects using various algorithms.\r
+\r
+It is possible to easily set :ref:`parameters` predefined to be used as arguments when objects are created.\r
+\r
+SHAPER module preferences are described in the SHAPER :ref:`preferences` section of SALOME Help.\r
+\r
+Almost all SHAPER module functionalities are accessible via Python Interface.\r
+\r
+SHAPER module works with one study containing several documents:\r
+\r
+- partset\r
+- one or several parts.\r
+\r
+Only one document can be active.\r
+ \r
+New study contains only Partset with 7 default constructions which cannot be deleted:\r
+ \r
+- one point **Origin** coincing with origin of coordinate system;\r
+- three axes **OX**, **OY**, **OZ** coinciding with coordinate axes;\r
+- three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes. \r
+\r
+Only points, axis and plane (see :ref:`constructionPlugin`) and sketches (see :ref:`sketchPlugin`) can be added in Partset to be used in any part later.\r
+:ref:`parameters` created can be also used both in Partset and any Part.\r
+\r
+If parameter name in Partset and Part are identical then Part parameter has higher prority.\r
+ \r
+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:`primitivesPlugin`;\r
- :ref:`gdmlPlugin`;\r
- :ref:`featuresPlugin`; \r
-- :ref:`macrosPlugin`. \r
+- Macros. \r
\r
\r
\r
- :ref:`property_panel`\r
\r
Dock windows can be placed in three dock areas:\r
+ \r
- left, \r
- right, \r
- bottom.\r
\r
If Object Browser is shown at the same side then they will be tabbed.\r
\r
-Each dock window can be closed and opened again using a corresponding command from View - Windows pop-up menu on static part of main menu :ref:`main_menu`\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
+ :align: center\r
+\r
+.. centered::\r
+ Pop-up menu for visibilty of windows and toolbars\r
\r
\r
.. _object_browser: \r
Object browser\r
^^^^^^^^^^^^^^\r
\r
+Object browser contains all documents created in the active study shown in Tree View.\r
+\r
+Partset includes the following branches:\r
+\r
+- Parameters;\r
+- Constructions;\r
+- Features \r
\r
+Part includes the following branches:\r
+\r
+- Parameters;\r
+- Constructions;\r
+- Results;\r
+- Fields;\r
+- Groups; \r
+- Features. \r
+\r
+New part contains only 3 empty branches:\r
+ \r
+- Parameters;\r
+- Constructions;\r
+- Results; \r
\r
.. _property_panel:\r
\r
Viewer\r
------\r
\r
-The application supports one OCC viewer and is able to show only one 3D space.\r
+The application supports one OCC 3D viewer and is able to show only one 3D space.\r
+\r
+Architecture and functionality of OCC 3D Viewer is provided in GUI module user's guide in chapter **OCC 3D Viewer**.\r
+\r
+This 3D space can be represented in several view windows. New view window can be created using **Clone view** button in viewer toolbar.\r
\r
-This 3d space can be represented in several view windows.\r
+Each of view windows represents its own point of view on the 3D scene.\r
\r
-Each of view windows represents its own point of view on the 3d scene.\r
+This point of view can be modified by user with help of viewer commands like **Panning**, **Zooming**, **Scaling** and so on.\r
\r
-This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on.\r
\r
-Architecture and functionality of viewer is very similar to OCCViewer component from SALOME. \r
+.. image:: images/2_viewers.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Two view windows\r
+\r
+ \r
+.. _parameters:\r
+\r
+Parameters\r
+---------\r
+\r
+Parameter\r
+^^^^^^^^^\r
+\r
+\r
+\r
+.. _preferences:\r
+\r
+SHAPER preferences\r
+------------------\r
+\r
+Visualization tab\r
+^^^^^^^^^^^^^^^^^\r
+\r
+.. image:: images/visualization_preferences.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Preferences - Visualization tab\r
+\r
+Plugins tab\r
+^^^^^^^^^^^\r
+\r
+.. image:: images/plugins_preferences.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Preferences - Plugins tab\r
+\r
+Sketch tab\r
+^^^^^^^^^^\r
+\r
+.. image:: images/sketch_preferences.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Preferences - Sketch tab\r
+\r
+Viewer tab\r
+^^^^^^^^^^\r
+\r
+.. image:: images/viewer_preferences.png\r
+ :align: center\r
+\r
+.. centered::\r
+ Preferences - Viewer tab \r
