doc/salome/gui/GEOM/input/glue_faces_operation.doc

   1 /*!
   2
   3 \page glue_faces_operation_page Glue Faces
   4
   5 \n To <b>Glue Faces</b> in the <b>Main Menu</b> select <b>Repair - > Glue Faces</b>.
   6
   7
   8 \n This operation glues faces that are coincident with respect to the
   9 given tolerance value.
  10
  11 \n <b>Arguments:</b> Name + Shapes + Tolerance value.
  12 \n <b>Advanced option:</b>
  13    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  14 \n The \b Result will be a \b GEOM_Object.
  15
  16 \image html glue1.png
  17
  18
  19 \n <b>TUI Commands:</b>
  20
  21 <em>geompy.MakeGlueFaces( theShapes, theTolerance, doKeepNonSolids )</em>,
  22 \n where \em theShapes is either a list or compound of shapes to be glued, \em
  23  theTolerance is a maximum distance between two faces, which can
  24  be considered as coincident. The \em doKeepNonSolids flag allows to
  25  throw away non-solids from the result, if false. The \b Result will
  26  be a new \b GEOM_Object.
  27
  28 \n It is also possible to manually select the faces that will be
  29 glued - select the shape, specify the tolerance and press \b Detect button.
  30
  31 \image html glue2.png
  32
  33 \n \b Geometry module detects the faces where gluing can be
  34 performed and displays a notification.
  35
  36 \image html glue3.png
  37
  38 \n The faces that can be glued are colored in red. It is
  39 possible to select the faces for gluing in the 3D viewer.
  40 The selected faces will be marked in white.
  41
  42 When the faces are glued their edges are glued as well. By default, other
  43 edges are not glued. To force gluing of all edges, check <b>Glue all coincident edges</b>
  44 check-box.
  45
  46 \n <b>TUI Commands:</b>
  47
  48 <em>geompy.GetGlueFaces( theShapes, theTolerance )</em>,
  49 \n where \em theShapes is a list or compound of shapes to be glued, \em
  50 theTolerance is a maximum distance between two faces, which can
  51 be considered as coincident. The \b Result will be a list of \b
  52 GEOM_Objects (faces), containing one sub-shape per each detected set of
  53 coincident sub-shapes. For example if there are two coincident faces
  54 in selected shapes, the result list contains one of the two coincident faces.
  55
  56 <em>geompy.MakeGlueFacesByList( theShapes, theTolerance, theFaces,
  57   doKeepNonSolids, doGlueAllEdges )</em>,
  58 \n where \em theShapes is either a list or compound of shapes to be glued, \em
  59  theTolerance is a maximum distance between two faces, which can
  60  be considered as coincident, \em theFaces is a list of
  61  sub-shapes to be glued. The \em doKeepNonSolids flag allows to throw
  62  away non-solids from the result, if false. The \em doGlueAllEdges
  63  allows to glue all edges, not only owned by glued faces. The \b
  64  Result will be a new \b GEOM_Object.
  65
  66 \n <b>Example:</b>
  67
  68 \image html glue_faces1.png
  69 <center><em>Object that needs gluing</em></center>
  70
  71 \image html glue_faces2.png
  72 <center><em>Glued object</em></center>
  73
  74 \image html glue_faces3.png
  75 <center><em>Manual selection of faces for gluing</em></center>
  76
  77 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  78 <b>Repairing Operations</b> \ref tui_glue_faces "Glue Faces".
  79
  80 */