Salome HOME
Ameliorate help pages
[modules/shaper.git] / src / BuildPlugin / doc / wireFeature.rst
1 .. |feature_wire.icon|    image:: images/feature_wire.png
2
3 Wire
4 ====
5
6 Wire feature creates a wire using edges already existing in other objects.
7
8 To create a wire in the active part:
9
10 #. select in the Main Menu *Build - > Wire* item  or
11 #. click |feature_wire.icon| **Wire** button in the toolbar
12
13 The following property panel will be opened:
14
15 .. image:: images/Wire.png
16   :align: center
17
18 .. centered::
19   Create a wire
20   
21 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.
22
23 **Apply** button creates a wire.
24
25 **Cancel** button cancels the operation. 
26
27 **TUI Command**:
28
29 .. py:function:: model.addWire(Part_doc, Shapes)
30
31     :param part: The current part object.
32     :param list: A list of shapes.
33     :return: Result object.
34
35 Result
36 """"""
37
38 The result of the operation will be a wire created from the selected shapes:
39
40 .. image:: images/CreateWire.png
41   :align: center
42
43 .. centered::
44   Result of the operation.
45
46 **See Also** a sample TUI Script of :ref:`tui_create_wire` operation.