X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FBuildPlugin%2Fdoc%2FpolylineFeature.rst;h=6df40143d04711e02eb5cc12df009e259f0b06b7;hb=bcd96990e1fca77402d522bc8b095ebfa1091894;hp=b58aa14f6d44ae55490e03288c3358a3d1991f06;hpb=547a3952b37fe76f0d4e031a7d8a943ac6a45bb5;p=modules%2Fshaper.git diff --git a/src/BuildPlugin/doc/polylineFeature.rst b/src/BuildPlugin/doc/polylineFeature.rst index b58aa14f6..6df40143d 100644 --- a/src/BuildPlugin/doc/polylineFeature.rst +++ b/src/BuildPlugin/doc/polylineFeature.rst @@ -1,3 +1,46 @@ +.. _buildPolyline: Polyline ======== + +Polyline feature creates a wire. + +To create a Polyline in the active part: + +#. select in the Main Menu *Build - > Polyline* item or +#. click **Polyline** button in the toolbar + +.. image:: images/feature_polyline.png + :align: center + +.. centered:: + **Polyline** button + +The following property panel appears. + +.. image:: images/Polyline.png + :align: center + +.. centered:: + Polyline property panel + +Input fields: + +- **Points and vertices** panel contains a list of points and vertices selected in 3D OCC viewer. The Polyline consequently connects points; +- **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened. + +**TUI Commands**: *model.addPolyline3D(Part_1_doc, Polyline_objects, Key)* + +**Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + Boolean key defining connection between the start and end points. + +Result +"""""" +The result of the operation is a closed or open Polyline. + +.. image:: images/CreatePolyline.png + :align: center + +.. centered:: + Polyline + +**See Also** a sample TUI Script of :ref:`tui_create_polyline` operation. \ No newline at end of file