src/BuildPlugin/doc/polylineFeature.rst

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