doc/salome/gui/GEOM/input/common_operation.doc

   1 /*!
   2
   3 \page common_operation_page Common
   4
   5 \b Common operation cuts the common part of a list of shapes and transforms it into an independent geometrical object.
   6
   7 To produce it, select in the main menu  <b>Operations - > Boolean - > Common</b>.
   8
   9 \image html bool2.png "Common dialog"
  10
  11 In this dialog:
  12 - Input or accept the default \b Name of the resulting shape.
  13 - Click the arrow button and select in the Object Browser or in the Viewer the <b>Objects</b> the common part which of should be found.
  14 - Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>
  15 - Activate the corresponding check-box if you wish to use a <b> fuzzy parameter </b>.
  16   If activated, you can define the fuzzy tolerance in the <b> fuzzy parameter </b> input box.
  17 - Activate \ref restore_presentation_parameters_page "Advanced options" if required.
  18 - Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
  19
  20
  21 \note This algorithm does not find all types of self-intersections. It is tuned
  22       to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
  23       intersections. Face/face intersections detection is switched off as it
  24       is a time-consuming operation that gives an impact on performance. To find
  25       all self-intersections use \ref check_self_intersections_page
  26       "Detect Self-intersection tool".
  27
  28
  29 This operation can be performed using a <b>TUI Command:</b>
  30
  31 <em>geompy.MakeCommonList(theShapesList, checkSelfInte, name, fuzzyParam)</em>
  32
  33 <b>Arguments:</b> a list of shapes + an optional flag for self-intersection check + an optional name + an optional fuzzy parameter.
  34
  35 There is also a special <b>TUI Command</b> for the Common operation on two shapes :
  36
  37 <em>geompy.MakeCommon(s1, s2, checkSelfInte, name, fuzzyParam)</em>
  38
  39 <b>Arguments:</b> 2 shapes + an optional flag for self-intersection check + an optional name + an optional fuzzy parameter.
  40
  41 <b>Example:</b>
  42
  43 \image html fusesn1.png "The initial shapes"
  44
  45 \image html commonsn.png "The resulting object"
  46
  47 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  48 \ref tui_common "Boolean Operations".
  49
  50 <b> More details </b>
  51
  52 Please, refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
  53 It provides a general review of the Partition and Boolean
  54 operations algorithms, describes the usage methodology and highlights
  55 major limitations of these operations.
  56
  57 */