src/BuildPlugin/doc/polylineFeature.rst

   1 .. _buildPolyline:
   2 .. |feature_polyline.icon|    image:: images/feature_polyline.png
   3
   4 Polyline
   5 ========
   6
   7 Polyline feature creates a wire.
   8
   9 To create a Polyline in the active part:
  10
  11 #. select in the Main Menu *Build - > Polyline* item  or
  12 #. click |feature_polyline.icon| **Polyline** button in the toolbar
  13
  14 The following property panel appears.
  15
  16 .. figure:: images/Polyline.png
  17   :align: center
  18
  19   Polyline property panel
  20
  21 Input fields:
  22
  23 - **Points and vertices** panel contains a list of points and vertices selected in 3D OCC viewer. The Polyline consequently connects points;
  24 - **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened.
  25
  26 **TUI Commands**:
  27
  28 .. py:function:: model.addPolyline3D(Part_1_doc, Polyline_objects, Key)
  29
  30     :param part: The current part object.
  31     :param list: list of vertices selected in format *model.selection("VERTEX", "Point")*.
  32     :param boolean: Is closed.
  33     :return: Result object.
  34
  35 Result
  36 """"""
  37 The result of the operation is a closed or open Polyline.
  38
  39 .. figure:: images/CreatePolyline.png
  40    :align: center
  41
  42    Polyline
  43
  44 **See Also** a sample TUI Script of :ref:`tui_create_polyline` operation.