src/CollectionPlugin/doc/groupFeature.rst

   1 .. |shape_group.icon|    image:: images/shape_group.png
   2 .. |plus.icon|  image:: images/add.png
   3 .. |minus.icon|  image:: images/reverce.png
   4 .. |delete.icon|  image:: images/delete.png
   5
   6 .. _groupPage:
   7
   8 Group
   9 =====
  10
  11 A group is a set of geometrical entities created by selection of sub-shapes of the same type.
  12 To create a Group in the active part:
  13
  14 #. select in the Main Menu *Features - > Group* item  or
  15 #. click |shape_group.icon| **Group** button in the toolbar:
  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. To delete entities from the list, select them and call pop-up menu *Delete* item.
  47
  48 - **Selection by filters** button opens "selection by filters" property panel and allows to select entities by set of selected filters. For details on filters see :ref:`filtersPlugin`
  49
  50 - **Show only** button allows to hide all other objects and shapes and show only selected ones.
  51
  52 - 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.
  53
  54
  55 **TUI Command**:
  56
  57 .. 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")])
  58
  59     :param part: The current part object
  60     :param list: A list of selected entities with type
  61     :return: Created object.
  62
  63 Result
  64 """"""
  65
  66 Created Group appears in the view.
  67
  68 .. image:: images/group_res.png
  69            :align: center
  70
  71 .. centered::
  72    Created group
  73
  74 **See Also** a sample TUI Script of :ref:`tui_create_group` operation.