Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / CollectionPlugin / doc / groupFeature.rst
index 1522bf7e0fe059036628439fb0bfdd13fb616c0a..becce7777eaedbae8bdbf0fd7653dd45ea0eebaa 100644 (file)
@@ -1,7 +1,6 @@
-.. |shape_group.icon|    image:: images/shape_group.png
-.. |plus.icon|  image:: images/add.png
-.. |minus.icon|  image:: images/reverce.png
-.. |delete.icon|  image:: images/delete.png
+.. |shape_group.icon| image:: images/shape_group.png
+
+.. _groupPage:
 
 Group
 =====
@@ -14,74 +13,37 @@ To create a Group in the active part:
 
 The following property panel appears. 
 
-.. image:: images/group_property_panel.png
+.. figure:: images/group_property_panel.png
   :align: center
 
-.. centered::
   Create a group
 
+.. |group_vertices| image:: images/group_property_panel_vertice.png
+.. |group_edges| image:: images/group_property_panel_edge.png
+.. |group_faces| image:: images/group_property_panel_face.png
+.. |group_solids| image:: images/group_property_panel_solid.png
+
 Input fields:
 
 - **Name** defines the name of the group, by default, it is **Group_n**.
 - **Type** buttons select geometrical entities to be included in group:
   
-    .. image:: images/group_property_panel_vertice.png
-         :align: left
-    Vertices;
-  
-    .. image:: images/group_property_panel_edge.png
-         :align: left
-    Edges;
+    |group_vertices| Vertices;
 
-    .. image:: images/group_property_panel_face.png
-         :align: left
-    Faces;
+    |group_edges| Edges;
 
-    .. image:: images/group_property_panel_solid.png
-         :align: left         
-    Solids;
+    |group_faces| Faces;
+
+    |group_solids| Solids;
  
 - The list of selected entities of the given type.  Multiple selection can be done manually in OCC 3D Viewer by mouse click with Shift button pressed or by rectangle selection. To delete entities from the list, select them and call pop-up menu *Delete* item.
 
-- **Selection by filters** button opens "selection by filters" property panel and allows to select entities by set of selected filters.
+- **Selection by filters** button opens "selection by filters" property panel and allows to select entities by set of selected filters. For details on filters see :ref:`filtersPlugin`
 
 - **Show only** button allows to hide all other objects and shapes and show only selected ones.
 
 - Control **Add elements that share the same topology** allows to add automatically all elements laying on the same topology that was selected and remove these elements if they have disappeared due to the parametrical update. They will be represented as one line in the list of selection and managed in the viewer as one object if this flag is enabled. If flag becomes disabled when such elements are already in the list, they will become divided in one line per one shape.
 
-**Selection by filters**
-
-If user presses this button then following property panel appears.
-
-.. image:: images/selection_by_filters.png
-  :align: center
-
-.. centered::
-  Selection by filters property panel
-
-In this panel:
-
-- **Filters** a panel for added filters.
-
-- **Add new filter** combo box. It contains accessible filters according to the selection mode defined in **Group** property panel. When user selects an item from this combo box a filter item appears in **Filters** panel like in the following example:
-
-.. image:: images/selection_by_filters_added.png
-  :align: center
-
-.. centered::
-  Filters **Horizontal faces** and **On plane** added to the property panel.
-  
-Each filter item can be deleted with help of |delete.icon| button. A filter can be reverced with help of toggle button |plus.icon|/|minus.icon|. Also a filter could have input fields in case
-if the filter has arguments.
-
-- **Select** button traverces all objects of a current document and selects entities acceptable by currently defined set of filters. All selected entities will be shown in viewer 3d with
-blue semi-transparent color. Any modification in filters clears current selection.
-
-- **Number of selected objects** shows number currently selected entities.
-
-- **Show only** check box lets to hide all non-selected objects.
-
-**Accept** button in the **Selection by filters** property panel reopens **Group** property panel again and transfers all selected entities to the corresponded list.
 
 **TUI Command**:
 
@@ -96,10 +58,9 @@ Result
 
 Created Group appears in the view.
 
-.. image:: images/group_res.png
-          :align: center
+.. figure:: images/group_res.png
+   :align: center
 
-.. centered::
    Created group
 
 **See Also** a sample TUI Script of :ref:`tui_create_group` operation.