Salome HOME
Adding test for bos #41748 [CEA] Issue in interpolation edition
[modules/shaper.git] / src / BuildPlugin / doc / subShapesFeature.rst
index 1c5092d3fd935f7772ab577ab19af4f5eb125e50..6bf463bff29caffa0d39456b789592ac085d86ee 100644 (file)
@@ -1,51 +1,49 @@
+.. |feature_subshapes.icon|    image:: images/feature_subshapes.png
 
 Sub-shapes
 ==========
 
-The feature **Sub-shapes** lets to modify selected entity creating a non-manifold topology. It provides:
+The feature **Sub-shapes** modifies the selected entity by creating a non-manifold topology. It gives the possibility to:
 
-* add/remove vertices laying on edges of a wire;
-* add/remove edges and vertices laying on a face.
+* add/remove vertices lying on edges of a wire;
+* add/remove edges and vertices lying on a face.
 
 To create Sub-shapes in the active part:
 
 #. select in the Main Menu *Build - > Sub-shapes* item  or
-#. click **Sub-shapes** button in the toolbar
-
-.. image:: images/feature_subshapes.png 
-   :align: center
-
-.. centered::
-   **Sub-shapes** button 
+#. click |feature_subshapes.icon| **Sub-shapes** button in the toolbar
 
 The following property panel appears.
 
-.. image:: images/SubShapes.png
+.. figure:: images/SubShapes.png
   :align: center
 
-.. centered::
   Sub-shapes property panel
 
 Input fields:
 
-- **Shape** panel contains a shape to be modified. Shape is selected in 3D OCC viewer or object browser. For today it has to be wire or face;
-- **Sub-shapes** panel contains list of sub-shapes which are already included into result. A sub-shape can be deleted from the list or the list can be extended with new shapes selected in the view.
+- **Shape** panel contains the shape to be modified. The shape is selected in 3D OCC viewer or object browser. For today it has to be a wire or a face;
+- **Sub-shapes** panel contains the list of sub-shapes which are already included into result. A sub-shape can be deleted from the list or the list can be extended with new shapes selected in the view.
+
+**TUI Command**:
 
-**TUI Command**:  *model.addSubShapes(Part_doc, shape, sub-shapes)*
+.. py:function:: model.addSubShapes(Part_doc, shape, sub-shapes)
 
-**Arguments**: 1 part + shape in format *model.selection(TYPE, shape)* + list of sub-shapes in format *model.selection(TYPE, subshape)*.
+    :param part: The current part object.
+    :param object: A shape in format *model.selection(TYPE, shape)*.
+    :param list: A list of sub-shapes in format *model.selection(TYPE, subshape)*.
+    :return: Result object.
 
 Result
 """"""
-Result replaces original shape with the same one with added/removed sub-shapes.
+The result replaces the original shape with its copy with added/removed sub-shapes.
 
-.. image:: images/CreateSubShapes.png
+.. figure:: images/CreateSubShapes.png
    :align: center
 
-.. centered::
    Sub-shapes
 
-**See Also** a sample TUI Script of :ref:`tui_create_subshape` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_subshape` operation.