+.. |pipe.icon| image:: images/pipe.png
Pipe
====
-The feature **Pipe** makes an extruded Pipe shape.
+**Pipe** feature makes an extruded Pipe shape.
-To create Pipe in the active part:
+To create a Pipe in the active part:
#. select in the Main Menu *Features - > Pipe* item or
-#. click **Pipe** button in the toolbar
-
-.. image:: images/pipe.png
- :align: center
-
-.. centered::
- **Pipe** button
+#. click |pipe.icon| **Pipe** button in the toolbar
Pipe can be created in three different ways:
Input fields:
- **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;
-- **Path object** defines path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
+- **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;
-**TUI Command**: *model.addPipe(Part_doc, [shape], path)*
+**TUI Command**:
+
+.. py:function:: model.addPipe(Part_doc, [shape], path)
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + path in format *model.selection(TYPE, shape)*.
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param object: A path in format *model.selection(TYPE, shape)*.
+ :return: Created object.
Result
""""""
-Result of extrusion of arc along another arc.
+Result of extrusion of an arc along another arc.
.. image:: images/simplePipe.png
:align: center
.. centered::
Pipe by object and path
-**See Also** a sample TUI Script of a :ref:`tui_simple_pipe` operation.
+**See Also** a sample TUI Script of ref:`tui_simple_pipe` operation.
Pipe by object, path and Bi-normal
----------------------------------
Input fields:
- **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;
-- **Path object** defines path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
+- **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;
- **Bi-Normal** defines the BiNormal Vector. **Bi-Normal** (edge or wire) is selected in 3D OCC viewer or object browser.
-**TUI Command**: *model.addPipe(Part_doc, [shape], path, binormal)*
+**TUI Command**:
+
+.. py:function:: model.addPipe(Part_doc, [shape], path, binormal)
-**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)*.
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param object: A path in format *model.selection(TYPE, shape)*.
+ :param object: A binormal in format *model.selection(TYPE, shape)*.
+ :return: Created object.
Result
""""""
-Result of extrusion of rectangular face along arc.
+Result of extrusion of a rectangular face along arc.
.. image:: images/binormalPipe.png
:align: center
.. centered::
- Pipe by object and path
+ Pipe by object, path and Bi-normal
-**See Also** a sample TUI Script of a :ref:`tui_binormal_pipe` operation.
+**See Also** a sample TUI Script of :ref:`tui_binormal_pipe` operation.
Pipe by object, path and locations
----------------------------------
-The pipe is generated to preserve selected profiles at the specified locations along path.
+The pipe is generated to preserve selected profiles at the specified locations along the path.
.. image:: images/Pipe3.png
:align: center
Input fields:
- **Base objects** panel contains shapes to be extruded. Shapes (edges, faces, shells) are selected in 3D OCC viewer or object browser;
-- **Path object** defines path along which the Base Object will be extruded. **Path object** (edge or wire) is selected in 3D OCC viewer or object browser;
-- **Locations** define 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.
+- **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;
+- **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.
+
+**TUI Command**:
-**TUI Command**: *model.addPipe(Part_doc, [shape], path, locations)*
+.. py:function:: model.addPipe(Part_doc, [shape], path, locations)
-**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)*.
+ :param part: The current part object.
+ :param list: A list of shapes in format *model.selection(TYPE, shape)*.
+ :param object: A path in format *model.selection(TYPE, shape)*.
+ :param list: A list of locations in format *model.selection(TYPE, shape)*.
+ :return: Created object.
Result
""""""
.. centered::
Pipe by object, path and locations
-**See Also** a sample TUI Script of a :ref:`tui_locations_pipe` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_locations_pipe` operation.
\ No newline at end of file
