doc/salome/gui/GEOM/input/creating_pipe_path.doc

   1 /*!
   2
   3 \page create_pipe_path_page Restore Path
   4
   5 To generate a \b Path in the <b>Main Menu</b> select <b>New Entity - > Generation - > Restore Path</b>
   6
   7 \image html pipe_path_dlg.png
   8
   9 \n To obtain a \b Path of a pipe-like shape, you should define the
  10 <b>Pipe-like shell or solid</b> and two pipe \b Bases, each of them can
  11 be set as a wire, a face or a list of edges.<br>
  12 \n <b>Select unpublished edges</b> checkbox - if checked, allows
  13 selection of edges in the viewer, that are not published in the Object
  14 Browser.<br>
  15 \n The \b Result of the operation will be a GEOM_Object (edge or wire).<br>
  16
  17 \n <b>Advanced options</b>:
  18 <ul>
  19 <li>\ref preview_anchor "Preview"</li>
  20 </ul><br>
  21
  22 \note It is not assumed that exact or approximate copy of the Shape
  23       can be obtained by applying existing Pipe operation on the
  24       resulting "Path" wire taking the first Base as the base - it is
  25       not always possible; though in some particular cases it might
  26       work it is not guaranteed. Thus, RestorePath function should not
  27       be considered as an exact reverse operation of the Pipe.<br>
  28
  29 \n <b>Example:</b>
  30
  31 \image html pipe_path.png "Path (red) between two faces (green)"
  32
  33 \n <b>TUI Command:</b> <em>geompy.RestorePath(aShape, aBase1, aBase2)</em>
  34 \n <b>Arguments:</b> Name + 1 pipe-like shape (shell or solid) + 1
  35 shape (edge, wire or face) for the first base + 1 shape (edge, wire or
  36 face) for the last base.
  37 \n <b>TUI Command:</b> <em>geompy.RestorePathEdges(aShape, listEdges1, listEdges2)</em>
  38 \n <b>Arguments:</b> Name + 1 pipe-like shape (shell or solid) + 1
  39 list of edges for the first base + 1 list of edges for the last base.
  40
  41 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  42 \ref tui_creation_pipe_path "Complex Geometric Objects".
  43
  44 */