src/BuildPlugin/doc/edgeFeature.rst

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