doc/salome/gui/GEOM/input/working_with_groups.doc

   1 /*!
   2
   3 \page work_with_groups_page Working with groups
   4
   5 Creation and editing groups of subshapes of a geometrical object makes
   6 handling subshapes much easier. This functionality is available in OCC
   7 viewer only.
   8
   9 <br><h2>Create a group</h2>
  10
  11 \image html image56.gif
  12
  13 To create a group of subshapes of a geometrical object in the main
  14 menu select <b>New entity > Group > Create</b>
  15 \n The following menu will appear:
  16
  17 \image html geomcreategroup.png
  18
  19 In this Menu:
  20
  21 <ul>
  22 <li><b>Shape Type</b> radio button defines the type of elements for the
  23 group (points, wires, faces, shells or solids).</li>
  24 <li><b>Group Name</b> - here you can enter the name of the group, by
  25 default, it is Group_n.</li>
  26 <li>Then, using the "Select" button, select the <b>Main Shape</b> (a
  27 geometrical object on which the group will be created). </li>
  28 <li> You can select the elements of your group in two ways:
  29 <ul>
  30 <li>You can select them
  31 manually in the 3D Viewer, and add to the group by clicking the \b Add
  32 button (keep down the Shift button on the keyboard to select several
  33 elements and add all them together). The indexes of the selected
  34 elements will be displayed in the list. To delete elements from the
  35 list, select them and click \b Remove button.\n
  36     Checking in <b>Select in Place of Second Shape</b> box allows you
  37 to specify <b>Second Shape</b> which will restrict selection to those
  38 subshapes of the main shape that geometrically coincide with the
  39 Second Shape.
  40 </li>
  41 <li>Clicking <b>Select All</b> button you can add all object's
  42 elements of a certain type in the list of the elements of the
  43 group. To delete elements from the list, select them and click \b
  44 Remove button. If you set <b>Second shape</b>, action of <b>Select
  45 All</b> is limited to subshapes geometrically coincident with the
  46 Second Shape</li>
  47 </ul></li>
  48 <li>Finally, confirm your selection by clicking \b OK (also closes the
  49 Menu) or \b Apply (leaves the Menu open for creation of other groups),
  50 or skip it by clicking \b Close button.</li>
  51 </ul>
  52
  53 \n The Result of the operation will be a \b GEOM_Object.
  54
  55 \n <b>TUI Command:</b> <em>geompy.CreateGroup(MainShape,
  56 ShapeType),</em> where MainShape is a shape for which the group is
  57 created, ShapeType is a type of shapes in the created group.
  58 \n <b>Arguments:</b> 1 Shape + Type of subshape.
  59
  60 <b>Example:</b>
  61
  62 \image html image193.jpg
  63
  64
  65 <br><h2>Edit a group</h2>
  66
  67 \image html image57.gif
  68
  69 To \b Edit an existing group in the main menu select <b>New entity >
  70 Group > Edit</b>. This menu is designed in the same way as the
  71 <b>Create a group</b> menu.
  72
  73 \n The \b Result of the operation will be a \b GEOM_Object.
  74
  75 \n <b>TUI Command:</b>
  76 <ul>
  77 <li><em>geompy.AddObject(Group, SubShapeID),</em> where Group is a
  78 group to which a sub shape has to be added, SubShapeID is an ID of the
  79 sub shape to be added to the group.</li>
  80 <li><em>geompy.RemoveObject(Group, SubShapeID),</em> where Group is a
  81 group from which a sub shape has to be removed, SubShapeID is an ID of
  82 the sub shape to be removed from the group.</li>
  83 <li><em>geompy.GetObjectIDs(Group),</em> where Group is a group for which its object's are returned.
  84 \n Returns: List of IDs.</li>
  85 </ul>
  86
  87 \n <b>Arguments:</b> 1 Shape + its subshapes.
  88
  89 \n <b>Dialog Box:</b>
  90
  91 \image html editgroup.png
  92
  93 Our <b>TUI Scripts</b> provide you with useful examples of
  94 \ref tui_working_with_groups_page "Working with Groups".
  95
  96 */