src/CollectionPlugin/doc/groupAdditionFeature.rst

   1 .. |group_addition.icon|    image:: images/group_addition.png
   2
   3 Group Addition
   4 ==============
   5
   6 Group addition produces a union of all the elements of the selected groups.
   7 To create a Group Addition in the active part:
   8
   9 #. select in the Main Menu *Features - > Group Addition* item  or
  10 #. click |group_addition.icon| **Group Addition** button in the toolbar:
  11
  12 The following property panel appears.
  13
  14 .. image:: images/group_addition_property_panel.png
  15   :align: center
  16
  17 .. centered::
  18   Create a group addition operation
  19
  20 Input fields:
  21
  22 - **Name** defines the name of the group, by default, it is **GroupAddition_n**.
  23 - The list of selected groups of the same 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.
  24
  25 Note, that operation is valid only for the groups of the same type.
  26
  27 **TUI Command**:
  28
  29 .. py:function:: model.addGroupAddition(Part_1_doc,
  30                                        [model.selection("COMPOUND", "Group_1"), model.selection("COMPOUND", "Group_2")])
  31
  32     :param part: The current part object
  33     :param list: A list of selected groups
  34     :return: Created group.
  35
  36
  37 **See Also** a sample TUI Script of :ref:`tui_create_group_addition` operation.