doc/salome/gui/GEOM/input/close_contour_operation.doc

   1 /*!
   2
   3 \page close_contour_operation_page Close Contour
   4
   5 \n To produce a <b>Close Contour</b> operation in the <b>Main Menu</b>
   6 select <b>Repair - > Close Contour</b>.
   7
   8 \n This operation closes an open contour and modifies the underlying
   9 face (if needed) in accordance with user specified mode:
  10 <ul>
  11 <li>By common vertex &ndash; a vertex is created between the end points
  12 of the contour and its tolerance is increased to a value of the gap
  13 between the ends of the contour;</li>
  14 <li>By new edge &ndash; a new edge is inserted between the end points of the contour.</li>
  15 </ul>
  16 This operation is available in <b>OCC Viewer</b> only.
  17
  18 \n The \b Result will be a \b GEOM_Object.
  19
  20 \n <b>TUI Command:</b> <em>geompy.CloseContour(Shape, Wires,
  21 IsCommonVertex),</em> where \em Shape is a shape to be processed, \em Wires is
  22 a list of edges or wires ID's which has to be closed within the
  23 shape (if the list contains only one element = -1, the shape itself is
  24 considered as a wire), \em IsCommonVertex if this parameter is True a
  25 closure has to be done by creation of a common vertex, otherwise an
  26 edge is added between the end vertices.
  27 \n <b>Arguments:</b> Name + 1 shape + contour (Wire, or a set of
  28 Edges) + mode of closure (by vertex or by edge)
  29
  30 \image html repair3.png
  31
  32 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  33 \ref tui_close_contour "Repairing Operations".
  34
  35 */