Salome HOME
Ameliorate help pages
[modules/shaper.git] / src / BuildPlugin / doc / wireFeature.rst
index a7b22081aaa88573c2343e5fd660821fb568a88f..32d03e58fe62f36773f649833cc24c97f68ca754 100644 (file)
@@ -1,10 +1,46 @@
+.. |feature_wire.icon|    image:: images/feature_wire.png
 
 Wire
 ====
 
+Wire feature creates a wire using edges already existing in other objects.
+
+To create a wire in the active part:
+
+#. select in the Main Menu *Build - > Wire* item  or
+#. click |feature_wire.icon| **Wire** button in the toolbar
+
+The following property panel will be opened:
 
 .. image:: images/Wire.png
   :align: center
 
 .. centered::
   Create a wire
+  
+Select one or several edges in the viewer. For automatic selection of a closed contour starting from the selected edge it is necessary to press **Add contour** button.
+
+**Apply** button creates a wire.
+
+**Cancel** button cancels the operation. 
+
+**TUI Command**:
+
+.. py:function:: model.addWire(Part_doc, Shapes)
+
+    :param part: The current part object.
+    :param list: A list of shapes.
+    :return: Result object.
+
+Result
+""""""
+
+The result of the operation will be a wire created from the selected shapes:
+
+.. image:: images/CreateWire.png
+  :align: center
+
+.. centered::
+  Result of the operation.
+
+**See Also** a sample TUI Script of :ref:`tui_create_wire` operation.