doc/salome/gui/GEOM/input/shared_shapes.doc

   1 /*!
   2
   3 \page shared_shapes_page Get Shared Shapes
   4
   5 This operation is a special case of <b>Explode</b> operation. It
   6 produces sub-shapes of the exploded shape (the first shape in the list
   7 of argument shapes), which are shared with other shapes in the
   8 arguments. The argument shapes can also be contained in a compound or
   9 group.
  10
  11 To use this operation, select in the Main Menu <b>Operations -> Get
  12 Shared Shapes.</b> The following dialog box will appear.
  13
  14 \image html shared_shapes.png
  15
  16 In this dialog:
  17 - <b>Name</b> is the base name of the resulting shapes.
  18 - <b>Shapes</b> are the shapes whose shared sub-shapes should be found.
  19 - <b>Sub-shapes Type</b> is the type of required sub-shapes.
  20 - <b>Shared by all</b> option specifies what type of shared sub-shapes should be checked:
  21   - \b On: searches for sub-shapes from the first input shape shared with all other input shapes;
  22   - \b Off: searches for sub-shapes shared between couples of input shapes.
  23
  24 \note For the case when "Shared by all" option is switched off - if an input list of shapes
  25 contains a single compound, the sub-shapes shared between all possible couples of its top-level shapes
  26 are searched for; otherwise, only sub-shapes that are shared between the first input shape and
  27 all other input shapes are searched.
  28
  29 <b>Advanced options:</b> \ref preview_anchor "Preview"
  30
  31 <b>TUI Command:</b> <em> geompy.GetSharedShapesMulti( Shapes, Type ),</em>
  32 <br> where \em Shapes is a list or compound of shapes, whose shared sub-
  33 shapes should be found and \em Type is the type of required sub-shapes.
  34
  35 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  36 Get Shared Shapes functionality:
  37 - \ref tui_shared_shapes "Example 1"
  38 - \ref swig_GetSharedShapes "Example 2"
  39
  40 */