Salome HOME
Issue #3127: Add help description for Hide Faces panel
authorvsv <vsv@opencascade.com>
Thu, 19 Dec 2019 08:43:54 +0000 (11:43 +0300)
committervsv <vsv@opencascade.com>
Thu, 19 Dec 2019 08:43:54 +0000 (11:43 +0300)
doc/gui/Introduction.rst
doc/gui/images/hide_faces_panel.png [new file with mode: 0644]

index c35c806f64609bfa65a0e587bdb6d1e64a8e1fd1..809b19308cb1820fbaf32bddcf106c65bc62639c 100644 (file)
@@ -143,6 +143,7 @@ Standard dock windows are:
 \r
 - :ref:`object_browser`\r
 - :ref:`inspection_panel`\r
+- :ref:`hidefaces_panel`\r
 - :ref:`python console`\r
 - :ref:`property_panel`\r
 \r
@@ -354,6 +355,28 @@ The information about  Plane, Face additionally shows coordinates of center poin
 .. centered::\r
    Inspection panel for Face \r
 \r
+.. _hidefaces_panel:\r
+\r
+Hide Faces 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
+   :align: center\r
+\r
+.. centered::\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
+- 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.\r
+- 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.\r
+\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
diff --git a/doc/gui/images/hide_faces_panel.png b/doc/gui/images/hide_faces_panel.png
new file mode 100644 (file)
index 0000000..c0a2e70
Binary files /dev/null and b/doc/gui/images/hide_faces_panel.png differ