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   by object and path
  18
  19   .. image:: images/pipe_binormal_32x32.png
  20     :align: left
  21   by object, path and Bi-normal
  22
  23   .. image:: images/pipe_locations_32x32.png
  24     :align: left
  25   by object, path and locations
  26
  27 Pipe by object and path
  28 -----------------------
  29
  30 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.
  31
  32 .. image:: images/Pipe1.png
  33   :align: center
  34
  35 .. centered::
  36   Pipe by object and path property panel
  37
  38 Input fields:
  39
  40 - **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;
  41 - **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;
  42
  43 **TUI Command**:
  44
  45 .. py:function:: model.addPipe(Part_doc, [shape], path)
  46
  47     :param part: The current part object.
  48     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  49     :param object: A path in format *model.selection(TYPE, shape)*.
  50     :return: Created object.
  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**:
  83
  84 .. py:function:: model.addPipe(Part_doc, [shape], path, binormal)
  85
  86     :param part: The current part object.
  87     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
  88     :param object: A path in format *model.selection(TYPE, shape)*.
  89     :param object: A binormal in format *model.selection(TYPE, shape)*.
  90     :return: Created object.
  91
  92 Result
  93 """"""
  94
  95 Result of extrusion of a rectangular face along  arc.
  96
  97 .. image:: images/binormalPipe.png
  98    :align: center
  99
 100 .. centered::
 101    Pipe by object, path and Bi-normal
 102
 103 **See Also** a sample TUI Script of :ref:`tui_binormal_pipe` operation.
 104
 105 Pipe by object, path and locations
 106 ----------------------------------
 107
 108 The pipe is generated to preserve selected profiles at the specified locations along the path.
 109
 110 .. image:: images/Pipe3.png
 111   :align: center
 112
 113 .. centered::
 114   Pipe by object, path and locations property panel
 115
 116 Input fields:
 117
 118 - **Base objects** panel contains shapes to be extruded.  Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
 119 - **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;
 120 - **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.
 121
 122 **TUI Command**:
 123
 124 .. py:function:: model.addPipe(Part_doc, [shape], path, locations)
 125
 126     :param part: The current part object.
 127     :param list: A list of shapes in format *model.selection(TYPE, shape)*.
 128     :param object: A path in format *model.selection(TYPE, shape)*.
 129     :param list: A list of locations in format *model.selection(TYPE, shape)*.
 130     :return: Created object.
 131
 132 Result
 133 """"""
 134
 135 Result of extrusion of 3 circles along arc with specified locations.
 136
 137 .. image:: images/locationPipe.png
 138    :align: center
 139
 140 .. centered::
 141    Pipe by object, path and locations
 142
 143 **See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.