Salome HOME
Issue #2660: Update data model before save.
[modules/shaper.git] / src / CollectionPlugin / doc / groupFeature.rst
index c17ee91869aeaee0df25a6d256781e4309caf03e..1fbc36dbc2a82d7e6c03cb0b8d9e647779a0695e 100644 (file)
@@ -1,3 +1,66 @@
 
 Group
 =====
+
+To create Group in the active part:
+
+#. select in the Main Menu *Features - > Group* item  or
+#. click **Group** button in Shaper toolbar:
+
+.. image:: images/shape_group.png
+  :align: center
+
+.. centered::
+   Group button
+
+The following property panel appears. 
+
+.. image:: images/group_property_panel.png
+  :align: center
+
+.. centered::
+  Create a group
+
+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;
+
+    .. image:: images/group_property_panel_face.png
+         :align: left
+    Faces;
+
+    .. image:: images/group_property_panel_solid.png
+         :align: left         
+    Solids;
+- List of selected entities of given type.  Multiply 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.
+
+
+**TUI Command**: *model.addGroup(Part_1_doc, [model.selection("EDGE", "Cone_1_1/Face_1&Cone_1_1/Face_2"), model.selection("EDGE", "Cone_1_1/Face_1")])*
+
+**Arguments**:  1 part + list of selected entities with type
+
+
+Result
+""""""
+
+Created Group appears in the view.
+
+.. image:: images/group_res.png
+          :align: center
+
+.. centered::
+   Group created
+
+**See Also** a sample TUI Script of a :ref:`tui_create_group` operation.