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 + Compound of 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 \n <em>geompy.MakeGlueFaces(theShape,theTolerance,doKeepNonSolids)</em>,
  21 \n where \em theShape is a compound of shapes to be glued, \em
  22  theTolerance is a maximum distance between two faces, which can
  23  be considered as coincident. The \em doKeepNonSolids flag allows to
  24  throw away non-solids from the result, if false. The \b Result will
  25  be a new \b GEOM_Object.
  26
  27 \n It is also possible to manually select the faces that will be
  28 glued - select the shape, specify the tolerance and press \b Detect button.
  29
  30 \image html glue2.png
  31
  32 \n \b Geometry module detects the faces where gluing can be
  33 performed and displays a notification.
  34
  35 \image html glue3.png
  36
  37 \n The faces that can be glued are colored in red. It is
  38 possible to select the faces for gluing in the 3D viewer.
  39 The selected faces will be marked in white.
  40
  41 \n When the faces are glued their edges are glued as well. By default, other
  42 edges are not glued. To force gluing of all edges, check <b>Glue all coincident edges</b>
  43 checkbox.
  44
  45 \n <b>TUI Commands:</b>
  46 \n <em>geompy.GetGlueFaces(theShape,theTolerance)</em>,
  47 \n where \em theShape is a compound of shapes to be glued, \em
  48  theTolerance is a maximum distance between two faces, which can
  49  be considered as coincident. The \b Result will be a list of \b
  50  GEOM_Objects, containing one sub-shape per each detected set of
  51  coincident sub-shapes.
  52
  53 \n <em>geompy.MakeGlueFacesByList(theShape,theTolerance,theFaces,doKeepNonSolids,doGlueAllEdges)</em>,
  54 \n where \em theShape is a compound of shapes to be glued, \em
  55  theTolerance is a maximum distance between two faces, which can
  56  be considered as coincident, \em theFaces is a list of
  57  sub-shapes to be glued. The \em doKeepNonSolids flag allows to throw
  58  away non-solids from the result, if false. The \em doGlueAllEdges
  59  allows to glue all edges, not only owned by glued faces. The \b
  60  Result will be a new \b GEOM_Object.
  61
  62 \n <b>Example:</b>
  63
  64 \image html glue_faces1.png
  65 <center><em>Object that needs gluing</em></center>
  66
  67 \image html glue_faces2.png
  68 <center><em>Glued object</em></center>
  69
  70 \image html glue_faces3.png
  71 <center><em>Manual selection of faces for gluing</em></center>
  72
  73 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  74 <b>Repairing Operations</b> \ref tui_glue_faces "Glue Faces".
  75
  76 */