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