src/FeaturesPlugin/doc/pipeFeature.rst

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