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.
  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.
  34
  35 **Apply** button creates edges.
  36
  37 **Cancel** button cancels the operation.
  38
  39 **TUI Command**:
  40
  41 .. py:function:: model.addEdge(Part_doc, Shapes)
  42
  43     :param part: The current part object.
  44     :param list: A list of shapes.
  45     :return: Result object.
  46
  47 Result
  48 """"""
  49
  50 The result of the operation will be a set of edges created from the selected shapes:
  51
  52 .. image:: images/CreateEdge.png
  53   :align: center
  54
  55 .. centered::
  56   Result of the operation.
  57
  58 **See Also** a sample TUI Script of :ref:`tui_create_edge` operation.
  59
  60
  61 By two points
  62 -------------
  63
  64 .. image:: images/EdgeByTwoPoints.png
  65   :align: center
  66
  67 .. centered::
  68   Create by points
  69
  70 Select two points in the viewer.
  71
  72 **Apply** button creates a segment.
  73
  74 **Cancel** button cancels the operation.
  75
  76 **TUI Command**:
  77
  78 .. py:function:: model.addEdge(Part_doc, Point_1, Point_2)
  79
  80     :param part: The current part object.
  81     :param object: First point.
  82     :param object: Second point.
  83     :return: Result object.
  84
  85 Result
  86 """"""
  87
  88 The result of the operation will be a segment bounded by selected points:
  89
  90 .. image:: images/CreateEdgeByPoints.png
  91   :align: center
  92
  93 .. centered::
  94   Result of the operation.
  95
  96 **See Also** a sample TUI Script of :ref:`tui_create_segment` operation.