doc/salome/gui/GEOM/input/creating_groups.doc

   1 /*!
   2
   3 \page create_groups_page Generation of Groups
   4
   5 This option is available in some dialogs. To activate it please check
   6 <b>Generate Groups</b> check box. When it is checked, it is possible to define
   7 the prefix for generated groups names using <b>Group Names Prefix</b> input
   8 field.
   9
  10 \image html gen_group_dlg.png "Generate groups option in a dialog"
  11
  12 The groups are created along with the result of the operation when
  13 \b Apply or <b>Apply and Close</b> button is clicked. Each generated group
  14 represents a set of sub-shapes of the result that satisfies certain conditions.
  15 The groups of the following types can be generated:
  16  - \b Down - sub-shapes starting the result, e.g. bottom lid
  17 for the pipe creation operation.
  18  - \b Up - sub-shapes ending the result, e.g. top lid
  19 for the pipe creation operation.
  20  - \b Side1, \b Side2 - sub-shapes corresponding to each side
  21 of the result.
  22  - \b Other - faces generated from the bounding edges of
  23 \b Down group.
  24
  25 The groups are named according to the following naming rule:
  26 If <b>Group Names Prefix</b> is set <b><Prefix>_<Type></b>, otherwise
  27 the name is \b <Type>. The following figure shows group names created with
  28 the prefix \b Group:
  29
  30 \image html gen_group_tree.png "Group_Down, Group_Up, Group_Side1 and Group_Side2 are generated"
  31
  32
  33 The general behavior of this functionality is the following:
  34 <ul>
  35 <li>If <b>Generate Groups</b> option is not set, the groups are not generated.</li>
  36 <li>If starting and ending sub-shapes of the result are the same, e.g. if there is
  37 a closed path for pipe construction, <b>Generate Groups</b> option is disabled
  38 in the dialog box:</li>
  39
  40 \image html gen_group_disabled.png "Disabled option in the Pipe Construction dialog if the path is closed"
  41 \n
  42 <li>Otherwise If the path is not closed edge/wire, the groups are created depending
  43 on the profile:</li>
  44 <ul>
  45 <li>Profile is unclosed edge or wire: \b Down, \b Up, \b Side1, \b Side2:</li>
  46
  47 \image html gen_group_sides.png "Pipe with created groups Down(Red), Up(Green), Side1(Blue) and Side2(Yellow)"
  48 \n
  49 <li>Profile is closed edge or wire, face or shell: \b Down, \b Up, \b Other:</li>
  50
  51 \image html gen_group_other.png "Created groups Down(Red), Up(Green) and Other(Yellow)"
  52 </ul>
  53 </ul>
  54
  55 \b Down and \b Up groups contain:
  56 - Edges if the profile is edge or wire;
  57 - Faces if the profile is face or shell.
  58
  59 \b Side1 and \b Side2 groups contain edges generated from the first and
  60 last vertices of the profile edge or wire correspondingly. The first and
  61 last vertices are determined taking into account edge/wire orientation.
  62
  63 \b Other group represents faces generated from the bounding edges of profile.
  64
  65 The behavior in TUI is the following:
  66 - Each Python function that supports groups generation has a flag
  67 \b IsGenerateGroups which is equal to \b False by default.
  68 - If \b IsGenerateGroups is not set the groups are not created; the returned
  69 value is GEOM_Object that represents a result of the operation.
  70 - If \b IsGenerateGroups is set the operation returns a list of GEOM_Object.
  71 Its first element is a result, the remaining ones are the groups in the order:
  72 \b Down, \b Up, \b Side1, \b Side2 for opened profile or \b Down, \b Up,
  73 \b Other for closed profile.
  74 - If \b IsGenerateGroups is set and the path is closed an error occurs.
  75
  76 */