src/BuildPlugin/doc/edgeFeature.rst

   1 .. |feature_edge.icon|    image:: images/feature_edge.png
   2
   3 Edge
   4 ====
   5
   6 Edge feature creates one or several edges using shapes already existing in other objects.
   7
   8 To create edges in the active part:
   9
  10 #. select in the Main Menu *Build - > Edge* item  or
  11 #. click |feature_edge.icon| **Edge** button in the toolbar
  12
  13 The options to create edges:
  14
  15 .. image:: images/edge_by_segments_32x32.png
  16    :align: left
  17 **By edges** creates edges using already existing edges in other shapes or full sketches.
  18
  19 .. image:: images/edge_by_points_32x32.png
  20    :align: left
  21 **By points** creates segment between two points.
  22
  23
  24 By edges
  25 --------
  26
  27 .. image:: images/Edge.png
  28   :align: center
  29
  30 .. centered::
  31   Create by edges
  32
  33 Select one or several edges in the viewer. Also, the full sketch can be selected. In this case, all edges of the sketch will be processed.
  34 Checkbox **Compute intersections** forces to split sketch edges in the points of intersection.
  35
  36 **Apply** button creates edges.
  37
  38 **Cancel** button cancels the operation.
  39
  40 **TUI Command**:
  41
  42 .. py:function:: model.addEdge(Part_doc, Shapes, Intersect)
  43
  44     :param part: The current part object.
  45     :param list: A list of shapes.
  46     :param bool: Split edges by intersection points. False by default.
  47     :return: Result object.
  48
  49 Result
  50 """"""
  51
  52 The result of the operation will be a set of edges created from the selected shapes:
  53
  54 .. image:: images/CreateEdge.png
  55   :align: center
  56
  57 .. centered::
  58   Result of the operation.
  59
  60 **See Also** a sample TUI Script of :ref:`tui_create_edge` operation.
  61
  62
  63 By two points
  64 -------------
  65
  66 .. image:: images/EdgeByTwoPoints.png
  67   :align: center
  68
  69 .. centered::
  70   Create by points
  71
  72 Select two points in the viewer.
  73
  74 **Apply** button creates a segment.
  75
  76 **Cancel** button cancels the operation.
  77
  78 **TUI Command**:
  79
  80 .. py:function:: model.addEdge(Part_doc, Point_1, Point_2)
  81
  82     :param part: The current part object.
  83     :param object: First point.
  84     :param object: Second point.
  85     :return: Result object.
  86
  87 Result
  88 """"""
  89
  90 The result of the operation will be a segment bounded by selected points:
  91
  92 .. image:: images/CreateEdgeByPoints.png
  93   :align: center
  94
  95 .. centered::
  96   Result of the operation.
  97
  98 **See Also** a sample TUI Script of :ref:`tui_create_segment` operation.