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