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