Salome HOME
Merge remote-tracking branch 'origin/master' into gni/documentation
[modules/shaper.git] / src / BuildPlugin / doc / interpolationFeature.rst
index 8b61969df807e8c3d373f346ac8bc1841c51858b..2da696243c2e9bb93d8913a1961882ce8f1dd9f1 100644 (file)
@@ -1,59 +1,62 @@
+.. |feature_interpolation.icon|    image:: images/feature_interpolation.png
 
 Interpolation
 =============
 
-The Interpolation feature creates curve (wire) using already existing vertices in other objects.
+Interpolation feature creates a curve (edge) using vertices already existing in other objects.
 
-To create interpolation in the active part:
+To create an interpolation in the active part:
 
 #. select in the Main Menu *Build - > Interpolation* item  or
-#. click **Interpolation** button in the toolbar
-
-.. image:: images/feature_interpolation.png
-  :align: center
-
-.. centered::
-  **Interpolation** button
+#. click |feature_interpolation.icon| **Interpolation** button in the toolbar
 
 The following property panel will be opened:
 
-.. image:: images/Interpolation.png
+.. figure:: images/Interpolation.png
   :align: center
 
-.. centered::
   Create an interpolation
 
-Select one or several vertices or points in a viewer.
+Select one or several vertices or points in the viewer.
 
 - **Closed** makes the interpolation curve closed.
 
-- **Reorder** reorders selected points to minimize length of the curve.
+- **Reorder** reorders the selected points to minimize the length of curve.
 
-- **Tangents** makes start and end of the curve tangent to selected edges. User has to select edges for start and end in corresponded fields.
+- **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.
 
 **Apply** button creates an interpolation.
 
-**Cancel** button cancels operation. 
+**Cancel** button cancels the operation. 
 
-**TUI Command**:
+**TUI Commands**:
 
-- *model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)*.
+.. py:function:: model.addInterpolation(Part_doc, Points, IsClosed, IsReordered)
 
-**Arguments**:   Part document + list of points + is closed + is reordered.
+    :param part: The current part object.
+    :param list: A list of points.
+    :param boolean: Is closed.
+    :param boolean: Is reordered.
+    :return: Result object.
 
-- *model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)*.
+.. py:function:: model.addInterpolation(Part_doc, Points, StartEdge, EndEdge, IsClosed, IsReordered)
 
-**Arguments**:   Part document + list of points + start edge + end edge + is closed + is reordered.
+    :param part: The current part object.
+    :param list: A list of points.
+    :param object: Start point.
+    :param object: End point.
+    :param boolean: Is closed.
+    :param boolean: Is reordered.
+    :return: Result object.
 
 Result
 """"""
 
-The result of the operation will be a curve created from selected shapes:
+The result of the operation will be a curve created from the selected shapes:
 
-.. image:: images/CreateInterpolation.png
+.. figure:: images/CreateInterpolation.png
   :align: center
 
-.. centered::
   Result of the operation.
 
-**See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_interpolation` operation.