src/FeaturesPlugin/doc/placementFeature.rst

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