Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / placementFeature.rst
index 51d6a0a38e4ea177e37ca52238e04d7df5cf3c1f..6ce1e3ea7057994ea5c4bd9ca95c6a19c2ba6620 100644 (file)
@@ -1,17 +1,12 @@
+.. |placement_btn.icon|    image:: images/placement_btn.png
 
 Placement
 =========
 
-Placement lets to place a one object relatively to another object. To make a placement:
+Placement defines position of an object relatively to another object. To make a placement:
 
 #. select in the Main Menu *Part - > Placement* item  or
-#. click **Placement** button in the toolbar
-
-.. image:: images/placement_btn.png
-   :align: center
-
-.. centered::
-   **Placement**  button 
+#. click |placement_btn.icon| **Placement** button in the toolbar
 
 The following property panel will be opened:
 
@@ -21,25 +16,32 @@ The following property panel will be opened:
 .. centered::
    **Placement operation**
 
-In this property panel it is necessary:
+In this property panel, it is necessary to:
 
--  Select objects which will be moved.
+-  Select objects which will be moved;
 
--  Select a face, edge or vertex as a start for moving
+-  Select a face, edge or vertex as a start for moving;
 
--  Select a face, edge or vertex as an end of moving
+-  Select a face, edge or vertex as an end of moving;
 
 -  Define state of **Reverse** and **Centering** check boxes.
 
 
-
 **Apply** button creates the placement.
   
 **Cancel** button cancels the operation.
 
-**TUI Command**:  *model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering)*
+**TUI Command**:
+
+.. py:function:: model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering)
 
-**Arguments**:   Part + list of objects to move + start shape + end shape + is reverse flag + is centering flag.
+    :param part: The current part object.
+    :param list: A list of objects to move.
+    :param object: A start shape.
+    :param object: A end shape.
+    :param bool: Is reverse flag.
+    :param bool: Is centering flag.
+    :return: Created object.
 
 Result
 """"""
@@ -52,4 +54,4 @@ The Result of the operation will be a new placement of selected objects:
 .. centered::
    **Placement created**
 
-**See Also** a sample TUI Script of :ref:`tui_create_placement` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_placement` operation.