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 .. image:: images/Interpolation.png
  16   :align: center
  17
  18 .. centered::
  19   Create an interpolation
  20
  21 Select one or several vertices or points in the viewer.
  22
  23 - **Closed** makes the interpolation curve closed.
  24
  25 - **Reorder** reorders the selected points to minimize the length of curve.
  26
  27 - **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.
  28
  29 **Apply** button creates an interpolation.
  30
  31 **Cancel** button cancels the operation.
  32
  33 **TUI Commands**:
  34
  35 .. py:function:: model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)
  36
  37     :param part: The current part object.
  38     :param list: A list of points.
  39     :param boolean: Is closed.
  40     :param boolean: Is reordered.
  41     :return: Result object.
  42
  43 .. py:function:: model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)
  44
  45     :param part: The current part object.
  46     :param list: A list of points.
  47     :param object: Start point.
  48     :param object: End point.
  49     :param boolean: Is closed.
  50     :param boolean: Is reordered.
  51     :return: Result object.
  52
  53 Result
  54 """"""
  55
  56 The result of the operation will be a curve created from the selected shapes:
  57
  58 .. image:: images/CreateInterpolation.png
  59   :align: center
  60
  61 .. centered::
  62   Result of the operation.
  63
  64 **See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.