From: vsv <vsv@opencascade.com>
Date: Thu, 19 Dec 2019 08:43:54 +0000 (+0300)
Subject: Issue #3127: Add help description for Hide Faces panel
X-Git-Tag: V9_5_0a1~78
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=b77f8d4705c9aaccafa81d73f2bfed865ef7c89b;p=modules%2Fshaper.git

Issue #3127: Add help description for Hide Faces panel
---

diff --git a/doc/gui/Introduction.rst b/doc/gui/Introduction.rst
index c35c806f6..809b19308 100644
--- a/doc/gui/Introduction.rst
+++ b/doc/gui/Introduction.rst
@@ -143,6 +143,7 @@ Standard dock windows are:
 
 - :ref:`object_browser`
 - :ref:`inspection_panel`
+- :ref:`hidefaces_panel`
 - :ref:`python console`
 - :ref:`property_panel`
 
@@ -354,6 +355,28 @@ The information about  Plane, Face additionally shows coordinates of center poin
 .. centered::
    Inspection panel for Face 
 
+.. _hidefaces_panel:
+
+Hide Faces panel
+^^^^^^^^^^^^^^^^
+
+**Hide Faces** panel makes possible to hide temporary faces of any displayed object. **Hide Faces** panel looks like following:
+
+.. image:: images/hide_faces_panel.png
+   :align: center
+
+.. centered::
+   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.
+
+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.
+
+
 .. _python console:
 
 Python console
diff --git a/doc/gui/images/hide_faces_panel.png b/doc/gui/images/hide_faces_panel.png
new file mode 100644
index 000000000..c0a2e704b
Binary files /dev/null and b/doc/gui/images/hide_faces_panel.png differ