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 .. image:: images/Polyline.png
  17   :align: center
  18
  19 .. centered::
  20   Polyline property panel
  21
  22 Input fields:
  23
  24 - **Points and vertices** panel contains a list of points and vertices selected in 3D OCC viewer. The Polyline consequently connects points;
  25 - **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened.
  26
  27 **TUI Commands**:
  28
  29 .. py:function:: model.addPolyline3D(Part_1_doc, Polyline_objects, Key)
  30
  31     :param part: The current part object.
  32     :param list: list of vertices selected in format *model.selection("VERTEX", "Point")*.
  33     :param boolean: Is closed.
  34     :return: Result object.
  35
  36 Result
  37 """"""
  38 The result of the operation is a closed or open Polyline.
  39
  40 .. image:: images/CreatePolyline.png
  41    :align: center
  42
  43 .. centered::
  44    Polyline
  45
  46 **See Also** a sample TUI Script of :ref:`tui_create_polyline` operation.