Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / angularCopyFeature.rst
index c6c5eb047cc02a007e3e639e9b85e7ceda9d9822..3be46c1329c7c4468896a2666084dcfd21dfcf57 100644 (file)
@@ -1,20 +1,15 @@
 .. _featureAngularCopy:
+.. |multirotation.icon|    image:: images/multirotation.png
 
 Angular copy
 ============
 
 The feature **Angular copy** makes a compound of several rotated shapes basing on the initial shape. 
 
-To create Angular copy in the active part:
+To create an Angular copy in the active part:
 
 #. select in the Main Menu *Part - > Angular copy* item  or
-#. click **Angular copy** button in the toolbar
-
-.. image:: images/multirotation.png  
-   :align: center
-
-.. centered::
-   **Angular copy** button 
+#. click |multirotation.icon| **Angular copy** button in the toolbar
 
 The following property panel appears.
 
@@ -26,18 +21,25 @@ The following property panel appears.
 
 Input fields:
 
-- **Main objects** panel contains shapes to be rotated. Shapes are selected in 3D OCC viewer or object browser;
-- **Vector of rotation**  defines the axis of rotation. Vector is edge, axis selected in 3D OCC viewer or object browser;
+- **Main objects** panel contains shapes to be rotated. The shapes are selected in 3D OCC viewer or object browser;
+- **Vector of rotation**  defines the axis of rotation. The vector of rotation is an edge, axis selected in 3D OCC viewer or object browser;
 - **Angular Step** check-box turns on/off definition of the angle by which the object is rotated. By default (if the checkbox is not checked), **Angular Step** = 2 * PI / NbTimes;
 - **Nb. Copies** defines the number of rotated shape copies in the resulting compound. If **Nb. Copies** = 1, the result contains only the initial shape.
 
-**TUI Command**:  *model.addMultiRotation(Part_doc, [shape], axis, step, Nb)*
+**TUI Command**:
+
+.. py:function:: model.addMultiRotation(Part_doc, [shape], axis, step, Nb)*
 
-**Arguments**: part + list of shapes in format *model.selection(TYPE, shape)* + axis in format *model.selection(TYPE, shape)*+ real (step value) + integer (Nb. Copies).
+    :param part: The current part object
+    :param list: A list of shapes in format *model.selection(TYPE, shape)*
+    :param object: An axis in format *model.selection(TYPE, shape)*
+    :param real: a step value
+    :param integer: A number of copies
+    :return: Created object
 
 Result
 """"""
-Result of cylinder rotation is compound.
+Result of cylinder rotation is compound.
 
 .. image:: images/angularcopycyl.png
    :align: center
@@ -45,4 +47,4 @@ Result of cylinder rotation is compound.
 .. centered::
    Angular copy
 
-**See Also** a sample TUI Script of :ref:`tui_create_angularcopy` operation.  
+**See Also** a sample TUI Script of :ref:`tui_create_angularcopy` operation.