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 Moreover, the full sketch can be selected. In this case, a set of wires is composed using edges of the sketch.
  24 Checkbox **Compute intersections** forces to split sketch edges in the points of intersection.
  25
  26 **Apply** button creates a wire.
  27
  28 **Cancel** button cancels the operation.
  29
  30 **TUI Command**:
  31
  32 .. py:function:: model.addWire(Part_doc, Shapes, Intersect)
  33
  34     :param part: The current part object.
  35     :param list: A list of shapes.
  36     :param bool: Split edges by intersection points. False by default.
  37     :return: Result object.
  38
  39 Result
  40 """"""
  41
  42 The result of the operation will be a wire created from the selected shapes:
  43
  44 .. image:: images/CreateWire.png
  45   :align: center
  46
  47 .. centered::
  48   Result of the operation.
  49
  50 **See Also** a sample TUI Script of :ref:`tui_create_wire` operation.