src/BuildPlugin/doc/interpolationFeature.rst

   1 .. |feature_interpolation.icon|    image:: images/feature_interpolation.png
   2
   3 Interpolation
   4 =============
   5
   6 Interpolation feature creates a curve (edge) using vertices already existing in other objects.
   7
   8 To create an interpolation in the active part:
   9
  10 #. select in the Main Menu *Build - > Interpolation* item  or
  11 #. click |feature_interpolation.icon| **Interpolation** button in the toolbar
  12
  13 The following property panel will be opened:
  14
  15 .. figure:: images/Interpolation.png
  16   :align: center
  17
  18   Create an interpolation
  19
  20 Select one or several vertices or points in the viewer.
  21
  22 - **Closed** makes the interpolation curve closed.
  23
  24 - **Reorder** reorders the selected points to minimize the length of curve.
  25
  26 - **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.
  27
  28 **Apply** button creates an interpolation.
  29
  30 **Cancel** button cancels the operation.
  31
  32 **TUI Commands**:
  33
  34 .. py:function:: model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)
  35
  36     :param part: The current part object.
  37     :param list: A list of points.
  38     :param boolean: Is closed.
  39     :param boolean: Is reordered.
  40     :return: Result object.
  41
  42 .. py:function:: model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)
  43
  44     :param part: The current part object.
  45     :param list: A list of points.
  46     :param object: Start point.
  47     :param object: End point.
  48     :param boolean: Is closed.
  49     :param boolean: Is reordered.
  50     :return: Result object.
  51
  52 Result
  53 """"""
  54
  55 The result of the operation will be a curve created from the selected shapes:
  56
  57 .. figure:: images/CreateInterpolation.png
  58   :align: center
  59
  60   Result of the operation.
  61
  62 **See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.