src/FeaturesPlugin/doc/pipeFeature.rst

   1
   2 Pipe
   3 ====
   4
   5 **Pipe** feature makes an extruded Pipe shape.
   6
   7 To create a Pipe in the active part:
   8
   9 #. select in the Main Menu *Features - > Pipe* item  or
  10 #. click **Pipe** button in the toolbar
  11
  12 .. image:: images/pipe.png
  13    :align: center
  14
  15 .. centered::
  16    **Pipe** button
  17
  18 Pipe can be created in three different ways:
  19
  20   .. image:: images/pipe_simple_32x32.png
  21     :align: left
  22   by object and path
  23
  24   .. image:: images/pipe_binormal_32x32.png
  25     :align: left
  26   by object, path and Bi-normal
  27
  28   .. image:: images/pipe_locations_32x32.png
  29     :align: left
  30   by object, path and locations
  31
  32 Pipe by object and path
  33 -----------------------
  34
  35 Base Objects are extruded along the Path Object so that the angle between the normal vector to the base shape and the tangent to the path remain constant at any point of the given path.
  36
  37 .. image:: images/Pipe1.png
  38   :align: center
  39
  40 .. centered::
  41   Pipe by object and path property panel
  42
  43 Input fields:
  44
  45 - **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
  46 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
  47
  48 **TUI Command**:  *model.addPipe(Part_doc, [shape], path)*
  49
  50 **Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)*.
  51
  52 Result
  53 """"""
  54
  55 Result of extrusion of an arc along another arc.
  56
  57 .. image:: images/simplePipe.png
  58    :align: center
  59
  60 .. centered::
  61    Pipe by object and path
  62
  63 **See Also** a sample TUI Script of ref:`tui_simple_pipe` operation.
  64
  65 Pipe by object, path and Bi-normal
  66 ----------------------------------
  67
  68 The pipe is generated to preserve the constant angle between the normal vector to the base shape and the BiNormal vector at any point of the given path.
  69
  70 .. image:: images/Pipe2.png
  71   :align: center
  72
  73 .. centered::
  74   Pipe by object, path and Bi-normal property panel
  75
  76 Input fields:
  77
  78 - **Base objects** panel contains shapes to be extruded. Several Base Objects generate several pipes. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
  79 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
  80 - **Bi-Normal** defines the BiNormal Vector. **Bi-Normal** (edge or wire) is selected in 3D OCC viewer or object browser.
  81
  82 **TUI Command**:  *model.addPipe(Part_doc, [shape], path, binormal)*
  83
  84 **Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + binormal in format *model.selection(TYPE, shape)*.
  85
  86 Result
  87 """"""
  88
  89 Result of extrusion of a rectangular face along  arc.
  90
  91 .. image:: images/binormalPipe.png
  92    :align: center
  93
  94 .. centered::
  95    Pipe by object, path and Bi-normal
  96
  97 **See Also** a sample TUI Script of :ref:`tui_binormal_pipe` operation.
  98
  99 Pipe by object, path and locations
 100 ----------------------------------
 101
 102 The pipe is generated to preserve selected profiles at the specified locations along the path.
 103
 104 .. image:: images/Pipe3.png
 105   :align: center
 106
 107 .. centered::
 108   Pipe by object, path and locations property panel
 109
 110 Input fields:
 111
 112 - **Base objects** panel contains shapes to be extruded.  Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
 113 - **Path object**  defines the path along which the Base Object will be extruded.  **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
 114 - **Locations** define the list of vertices that specify the locations of extruded Base Objects on the resulting Path Object. The number of Base Objects should be equal to the number of Locations.
 115
 116 **TUI Command**:  *model.addPipe(Part_doc, [shape], path, locations)*
 117
 118 **Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)* + list of locations in format *model.selection(TYPE, shape)*.
 119
 120 Result
 121 """"""
 122
 123 Result of extrusion of 3 circles along arc with specified locations.
 124
 125 .. image:: images/locationPipe.png
 126    :align: center
 127
 128 .. centered::
 129    Pipe by object, path and locations
 130
 131 **See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.