src/BuildPlugin/doc/polylineFeature.rst

   1 .. _buildPolyline:
   2
   3 Polyline
   4 ========
   5
   6 The feature **Polyline** creates a wire.
   7
   8 To create a Polyline in the active part:
   9
  10 #. select in the Main Menu *Build - > Polyline* item  or
  11 #. click **Polyline** button in the toolbar
  12
  13 .. image:: images/feature_polyline.png
  14    :align: center
  15
  16 .. centered::
  17    **Polyline** button
  18
  19 The following property panel appears.
  20
  21 .. image:: images/Polyline.png
  22   :align: center
  23
  24 .. centered::
  25   Polyline property panel
  26
  27 Input fields:
  28
  29 - **Points and vertices** panel contains list of points and vertices selected in 3D OCC viewer. Polyline consequently connects points;
  30 - **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened.
  31
  32 **TUI Commands**:  *model.addPolyline3D(Part_1_doc, Polyline_objects, Key)*
  33
  34 **Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + boolean key defining presence of connection between the start and end points.
  35
  36 Result
  37 """"""
  38 Result of operation is 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 a :ref:`tui_create_polyline` operation.