src/PartSetPlugin/doc/PartSetPlugin.rst

   1 .. |new_part.icon|    image:: images/new_part.png
   2 .. |remove.icon|    image:: images/remove.png
   3 .. |duplicate.icon|    image:: images/duplicate.png
   4
   5 .. _partPlugin:
   6
   7 Part plug-in
   8 ============
   9
  10 .. _new-part:
  11
  12 New Part
  13 --------
  14
  15 To create a New Part:
  16
  17 #. select in the Main Menu *Part - > New part* item  or
  18 #. click |new_part.icon| **New part** button in Shaper toolbar:
  19
  20 **TUI Command**:
  21
  22 .. py:function:: model.addPart(partSet)
  23
  24     :param part: The current part object.
  25     :return: Result object.
  26
  27 Result
  28 """"""
  29
  30 Created empty part is activated and appears in the object browser.
  31
  32 **See Also** a sample TUI Script of :ref:`tui_create_part` operation.
  33
  34 Duplicate Part
  35 --------------
  36
  37 To duplicate an active Part:
  38
  39 #. select in the Main Menu *Part - > Duplicate part* item  or
  40 #. click |duplicate.icon| **Duplicate part** button in Shaper toolbar:
  41
  42 Result
  43 """"""
  44
  45 Created copied part is activated and appears in the object browser.
  46
  47 Copied part contains all objects existing in the source part.
  48
  49 Remove Part
  50 -----------
  51
  52 To remove an active Part:
  53
  54 #. select in the Main Menu *Part - > Remove part* item  or
  55 #. click |remove.icon| **Remove part** button in Shaper toolbar:
  56
  57 Result
  58 """"""
  59
  60 Selected part is removed together with all its objects.
  61
  62 Move Part
  63 -----------
  64 The part feature may be moved in the Object Browser by mouse Drag-and-Drop. For this user should
  65 press mouse left button on a Part feature and move it up or down along the PartSet features, then release the mouse button
  66 to put a moved part between other PartSet features.
  67
  68 The following conditions must be met:
  69
  70 - PartSet document must be active.
  71 - No operation is started.
  72 - The moved part(s) do not break order of depended objects.
  73
  74 Only enabled features could participate in the movement. If the history line arrow is located not in the end of the history
  75 of features and the user moves the Part much lower than this arrow, the Part feature will be dropped just after the arrow
  76 (the last active feature).