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 .. figure:: images/edge_by_segments_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 **By edges** creates edges using already existing edges in other shapes or full sketches.
  20
  21 .. figure:: images/edge_by_points_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 **By points** creates segment between two points.
  26
  27 --------------------------------------------------------------------------------
  28
  29 By edges
  30 --------
  31
  32 .. figure:: images/Edge.png
  33   :align: center
  34
  35   Create by edges
  36
  37 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.
  38 Checkbox **Compute intersections** forces to split sketch edges in the points of intersection.
  39
  40 **Apply** button creates edges.
  41
  42 **Cancel** button cancels the operation.
  43
  44 **TUI Command**:
  45
  46 .. py:function:: model.addEdge(Part_doc, Shapes, Intersect)
  47
  48     :param part: The current part object.
  49     :param list: A list of shapes.
  50     :param bool: Split edges by intersection points. False by default.
  51     :return: Result object.
  52
  53 Result
  54 """"""
  55
  56 The result of the operation will be a set of edges created from the selected shapes:
  57
  58 .. figure:: images/CreateEdge.png
  59   :align: center
  60
  61   Result of the operation.
  62
  63 **See Also** a sample TUI Script of :ref:`tui_create_edge` operation.
  64
  65
  66 By two points
  67 -------------
  68
  69 .. figure:: images/EdgeByTwoPoints.png
  70   :align: center
  71
  72   Create by points
  73
  74 Select two points in the viewer.
  75
  76 **Apply** button creates a segment.
  77
  78 **Cancel** button cancels the operation.
  79
  80 **TUI Command**:
  81
  82 .. py:function:: model.addEdge(Part_doc, Point_1, Point_2)
  83
  84     :param part: The current part object.
  85     :param object: First point.
  86     :param object: Second point.
  87     :return: Result object.
  88
  89 Result
  90 """"""
  91
  92 The result of the operation will be a segment bounded by selected points:
  93
  94 .. figure:: images/CreateEdgeByPoints.png
  95   :align: center
  96
  97   Result of the operation.
  98
  99 **See Also** a sample TUI Script of :ref:`tui_create_segment` operation.