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

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