src/BuildPlugin/doc/interpolationFeature.rst

   1
   2 Interpolation
   3 =============
   4
   5 Interpolation feature creates a curve (edge) using vertices already existing in other objects.
   6
   7 To create an interpolation in the active part:
   8
   9 #. select in the Main Menu *Build - > Interpolation* item  or
  10 #. click **Interpolation** button in the toolbar
  11
  12 .. image:: images/feature_interpolation.png
  13   :align: center
  14
  15 .. centered::
  16   **Interpolation** button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/Interpolation.png
  21   :align: center
  22
  23 .. centered::
  24   Create an interpolation
  25
  26 Select one or several vertices or points in the viewer.
  27
  28 - **Closed** makes the interpolation curve closed.
  29
  30 - **Reorder** reorders the selected points to minimize the length of curve.
  31
  32 - **Tangents** makes start and end of the curve tangent to the selected edges. The user has to select start and end edges in the corresponding fields.
  33
  34 **Apply** button creates an interpolation.
  35
  36 **Cancel** button cancels the operation.
  37
  38 **TUI Command**:
  39
  40 - *model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)*.
  41
  42 **Arguments**:   Part document + list of points + is closed + is reordered.
  43
  44 - *model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)*.
  45
  46 **Arguments**:   Part document + list of points + start edge + end edge + is closed + is reordered.
  47
  48 Result
  49 """"""
  50
  51 The result of the operation will be a curve created from the selected shapes:
  52
  53 .. image:: images/CreateInterpolation.png
  54   :align: center
  55
  56 .. centered::
  57   Result of the operation.
  58
  59 **See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.