From: Grigory ZHIVOTOVSKY Date: Wed, 12 Sep 2018 14:18:11 +0000 (+0300) Subject: Introduction help page updated, images moved to separate folder X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=5491f26b1f7c048bdead6de15e338934837af702;p=modules%2Fshaper.git Introduction help page updated, images moved to separate folder --- diff --git a/doc/gui/Introduction.rst b/doc/gui/Introduction.rst index 1e7f32dfb..54e9f5c95 100644 --- a/doc/gui/Introduction.rst +++ b/doc/gui/Introduction.rst @@ -5,6 +5,47 @@ Introduction to SHAPER ====================== +SHAPER module of SALOME is destined for: + +- import and export of geometrical models in IGES, BREP, STEP and XAO formats; +- parametrical construction of geometrical objects using a wide range of functions; + + - creation of complex 2D sections using :ref:`sketchPlugin` with consequent extrusion or revolution :ref:`featuresPlugin`; + - construction of model using primitives defined in :ref:`primitivesPlugin`; + - usage of Boolean operations :ref:`featuresPlugin`; + +- viewing geometrical objects in the OCC viewer; +- transformation of geometrical objects using various algorithms. + +It is possible to easily set :ref:`parameters` predefined to be used as arguments when objects are created. + +SHAPER module preferences are described in the SHAPER :ref:`preferences` section of SALOME Help. + +Almost all SHAPER module functionalities are accessible via Python Interface. + +SHAPER module works with one study containing several documents: + +- partset +- one or several parts. + +Only one document can be active. + +New study contains only Partset with 7 default constructions which cannot be deleted: + +- one point **Origin** coincing with origin of coordinate system; +- three axes **OX**, **OY**, **OZ** coinciding with coordinate axes; +- three planes **YOZ**, **XOZ**, **XOY** coinciding with coordinate planes. + +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. +:ref:`parameters` created can be also used both in Partset and any Part. + +If parameter name in Partset and Part are identical then Part parameter has higher prority. + +New Part can be created as described in :ref:`partPlugin`. + +Double click or pop-up menu can be used to activate existing document. + + Application desktop ------------------- @@ -53,7 +94,7 @@ and items specific for SHAPER module: - :ref:`primitivesPlugin`; - :ref:`gdmlPlugin`; - :ref:`featuresPlugin`; -- :ref:`macrosPlugin`. +- Macros. @@ -70,6 +111,7 @@ Standard dock windows are: - :ref:`property_panel` Dock windows can be placed in three dock areas: + - left, - right, - bottom. @@ -80,7 +122,13 @@ The Property Panel is shown on operation start at left dock area of the main win If Object Browser is shown at the same side then they will be tabbed. -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` +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. + +.. image:: images/popup_menu.png + :align: center + +.. centered:: + Pop-up menu for visibilty of windows and toolbars .. _object_browser: @@ -88,7 +136,28 @@ Each dock window can be closed and opened again using a corresponding command fr Object browser ^^^^^^^^^^^^^^ +Object browser contains all documents created in the active study shown in Tree View. + +Partset includes the following branches: + +- Parameters; +- Constructions; +- Features +Part includes the following branches: + +- Parameters; +- Constructions; +- Results; +- Fields; +- Groups; +- Features. + +New part contains only 3 empty branches: + +- Parameters; +- Constructions; +- Results; .. _property_panel: @@ -152,12 +221,71 @@ Python console Viewer ------ -The application supports one OCC viewer and is able to show only one 3D space. +The application supports one OCC 3D viewer and is able to show only one 3D space. + +Architecture and functionality of OCC 3D Viewer is provided in GUI module user's guide in chapter **OCC 3D Viewer**. + +This 3D space can be represented in several view windows. New view window can be created using **Clone view** button in viewer toolbar. -This 3d space can be represented in several view windows. +Each of view windows represents its own point of view on the 3D scene. -Each of view windows represents its own point of view on the 3d scene. +This point of view can be modified by user with help of viewer commands like **Panning**, **Zooming**, **Scaling** and so on. -This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on. -Architecture and functionality of viewer is very similar to OCCViewer component from SALOME. +.. image:: images/2_viewers.png + :align: center + +.. centered:: + Two view windows + + +.. _parameters: + +Parameters +--------- + +Parameter +^^^^^^^^^ + + + +.. _preferences: + +SHAPER preferences +------------------ + +Visualization tab +^^^^^^^^^^^^^^^^^ + +.. image:: images/visualization_preferences.png + :align: center + +.. centered:: + Preferences - Visualization tab + +Plugins tab +^^^^^^^^^^^ + +.. image:: images/plugins_preferences.png + :align: center + +.. centered:: + Preferences - Plugins tab + +Sketch tab +^^^^^^^^^^ + +.. image:: images/sketch_preferences.png + :align: center + +.. centered:: + Preferences - Sketch tab + +Viewer tab +^^^^^^^^^^ + +.. image:: images/viewer_preferences.png + :align: center + +.. centered:: + Preferences - Viewer tab diff --git a/doc/gui/images/2_viewers.png b/doc/gui/images/2_viewers.png new file mode 100755 index 000000000..62ba6a650 Binary files /dev/null and b/doc/gui/images/2_viewers.png differ diff --git a/doc/gui/images/plugins_preferences.png b/doc/gui/images/plugins_preferences.png new file mode 100755 index 000000000..f82715e7a Binary files /dev/null and b/doc/gui/images/plugins_preferences.png differ diff --git a/doc/gui/images/popup_menu.png b/doc/gui/images/popup_menu.png new file mode 100755 index 000000000..b7c62aaff Binary files /dev/null and b/doc/gui/images/popup_menu.png differ diff --git a/doc/gui/images/sketch_preferences.png b/doc/gui/images/sketch_preferences.png new file mode 100755 index 000000000..ae6ceb0ff Binary files /dev/null and b/doc/gui/images/sketch_preferences.png differ diff --git a/doc/gui/images/viewer_preferences.png b/doc/gui/images/viewer_preferences.png new file mode 100755 index 000000000..3a368852b Binary files /dev/null and b/doc/gui/images/viewer_preferences.png differ diff --git a/doc/gui/images/visualization_preferences.png b/doc/gui/images/visualization_preferences.png new file mode 100755 index 000000000..25cb63c64 Binary files /dev/null and b/doc/gui/images/visualization_preferences.png differ diff --git a/src/PartSetPlugin/doc/PartSetPlugin.rst b/src/PartSetPlugin/doc/PartSetPlugin.rst index 9dfd89688..96a3b4cc1 100644 --- a/src/PartSetPlugin/doc/PartSetPlugin.rst +++ b/src/PartSetPlugin/doc/PartSetPlugin.rst @@ -3,3 +3,5 @@ Part plug-in ============= + +New Part can be created using *Part* - *New part* main menu item or-