src/CollectionPlugin/doc/groupFeature.rst

   1 .. |shape_group.icon|    image:: images/shape_group.png
   2
   3 Group
   4 =====
   5
   6 A group is a set of geometrical entities created by selection of sub-shapes of the same type.
   7 To create a Group in the active part:
   8
   9 #. select in the Main Menu *Features - > Group* item  or
  10 #. click |shape_group.icon| **Group** button in the toolbar:
  11
  12 The following property panel appears.
  13
  14 .. image:: images/group_property_panel.png
  15   :align: center
  16
  17 .. centered::
  18   Create a group
  19
  20 Input fields:
  21
  22 - **Name** defines the name of the group, by default, it is **Group_n**.
  23 - **Type** buttons select geometrical entities to be included in group:
  24
  25     .. image:: images/group_property_panel_vertice.png
  26          :align: left
  27     Vertices;
  28
  29     .. image:: images/group_property_panel_edge.png
  30          :align: left
  31     Edges;
  32
  33     .. image:: images/group_property_panel_face.png
  34          :align: left
  35     Faces;
  36
  37     .. image:: images/group_property_panel_solid.png
  38          :align: left
  39     Solids;
  40
  41 - 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.
  42
  43 - **Selection by filters** button opens "selection by filters" property panel and allows to select entities by set of selected filters.
  44
  45 - **Show only** button allows to hide all other objects and shapes and show only selected ones.
  46
  47 - 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.
  48
  49 **Selection by filters**
  50
  51 If user press this button then following property panel will be opened.
  52
  53 .. image:: images/selection_by_filters.png
  54   :align: center
  55
  56 .. centered::
  57   Selection by filters property panel
  58
  59 **TUI Command**:
  60
  61 .. py:function:: 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")])
  62
  63     :param part: The current part object
  64     :param list: A list of selected entities with type
  65     :return: Created object.
  66
  67 Result
  68 """"""
  69
  70 Created Group appears in the view.
  71
  72 .. image:: images/group_res.png
  73            :align: center
  74
  75 .. centered::
  76    Created group
  77
  78 **See Also** a sample TUI Script of :ref:`tui_create_group` operation.