Salome HOME
91b7b38ab458c372c65f381670a0c7ac8775f55f
[modules/shaper.git] / src / FeaturesPlugin / doc / placementFeature.rst
1
2 Placement
3 =========
4
5 Placement defines position of an object relatively to another object. To make a placement:
6
7 #. select in the Main Menu *Part - > Placement* item  or
8 #. click **Placement** button in the toolbar
9
10 .. image:: images/placement_btn.png
11    :align: center
12
13 .. centered::
14    **Placement**  button 
15
16 The following property panel will be opened:
17
18 .. image:: images/Placement.png
19   :align: center
20
21 .. centered::
22    **Placement operation**
23
24 In this property panel, it is necessary to:
25
26 -  Select objects which will be moved;
27
28 -  Select a face, edge or vertex as a start for moving;
29
30 -  Select a face, edge or vertex as an end of moving;
31
32 -  Define state of **Reverse** and **Centering** check boxes.
33
34
35
36 **Apply** button creates the placement.
37   
38 **Cancel** button cancels the operation.
39
40 **TUI Command**:  *model.addPlacement(Part_doc, placeObjects, startShape, endShape, isReverse, isCentering)*
41
42 **Arguments**:   Part + list of objects to move + start shape + end shape + is reverse flag + is centering flag.
43
44 Result
45 """"""
46
47 The Result of the operation will be a new placement of selected objects:
48
49 .. image:: images/CreatedPlacement.png
50            :align: center
51
52 .. centered::
53    **Placement created**
54
55 **See Also** a sample TUI Script of :ref:`tui_create_placement` operation.