Salome HOME
Issue #2660: Update data model before save.
[modules/shaper.git] / src / CollectionPlugin / doc / groupFeature.rst
1
2 Group
3 =====
4
5 To create Group in the active part:
6
7 #. select in the Main Menu *Features - > Group* item  or
8 #. click **Group** button in Shaper toolbar:
9
10 .. image:: images/shape_group.png
11   :align: center
12
13 .. centered::
14    Group button
15
16 The following property panel appears. 
17
18 .. image:: images/group_property_panel.png
19   :align: center
20
21 .. centered::
22   Create a group
23
24 Input fields:
25
26 - **Name** defines the name of the group, by default, it is **Group_n**.
27 - **Type** buttons select geometrical entities to be included in group:
28   
29     .. image:: images/group_property_panel_vertice.png
30          :align: left
31     Vertices;
32   
33     .. image:: images/group_property_panel_edge.png
34          :align: left
35     Edges;
36
37     .. image:: images/group_property_panel_face.png
38          :align: left
39     Faces;
40
41     .. image:: images/group_property_panel_solid.png
42          :align: left          
43     Solids;
44  
45 - 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.
46
47 To delete entities from the list, select them and call pop-up menu *Delete* item.
48
49
50 **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")])*
51
52 **Arguments**:  1 part + list of selected entities with type
53
54
55 Result
56 """"""
57
58 Created Group appears in the view.
59
60 .. image:: images/group_res.png
61            :align: center
62
63 .. centered::
64    Group created
65
66 **See Also** a sample TUI Script of a :ref:`tui_create_group` operation.