src/FeaturesPlugin/doc/recoverFeature.rst

   1 .. |recover.icon|    image:: images/recover.png
   2
   3 Recover
   4 =======
   5
   6 **Recover** feature restores some objects used in previous operations.
   7
   8 To recover in the active part:
   9
  10 #. select in the Main Menu *Features - > Recover* item or
  11 #. click |recover.icon| **Recover** button in the toolbar
  12
  13 The feature has the following options:
  14
  15 .. figure:: images/recover_default_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 restore only the objects used in the operation
  20
  21 .. figure:: images/recover_compound_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 restore full compound/compsolid if the operation used one or more of its sub-shapes
  26
  27 --------------------------------------------------------------------------------
  28
  29 Recover objects
  30 ---------------
  31
  32 .. figure:: images/recover_mode_default.png
  33    :align: center
  34
  35    Recover objects used in operation
  36
  37 - **Feature** field contains one of the previous operations;
  38 - **List of recovered** objects contains all the shapes used in the operation. Need to enable checkbox to restore a shape.
  39
  40 **TUI Command**:
  41
  42 .. py:function:: model.addRecover(Part_doc, feature, [recovering_results])
  43
  44     :param part: The current part object.
  45     :param string: The name of the feature.
  46     :param list: A list of results used in the feature.
  47     :return: Created object.
  48
  49 Result
  50 """"""
  51
  52 Result of restoring the shape used in Split operation in compsolid is a single solid.
  53
  54 .. figure:: images/recover_res_default.png
  55    :align: center
  56
  57    Recover a solid
  58
  59 **See also** a sample TUI script of ref:`tui_recover_default` operation.
  60
  61
  62 Recover top-level objects
  63 -------------------------
  64
  65 .. figure:: images/recover_mode_compound.png
  66    :align: center
  67
  68    Recover top-level compounds/compsolids of objects used in operation
  69
  70 - **Feature** field contains one of the previous operations;
  71 - **List of recovered** objects contains all top-level shapes (compounds/compsolids) of the shapes used in the operation. Need to enable checkbox to restore a shape.
  72
  73 **TUI Command**:
  74
  75 .. py:function:: model.addRecover(Part_doc, feature, [recovering_results], True)
  76
  77     :param part: The current part object.
  78     :param string: The name of the feature.
  79     :param list: A list of results used in the feature.
  80     :param boolean: *True* to specify restoring compounds.
  81     :return: Created object.
  82
  83 Result
  84 """"""
  85
  86 Result of restoring the shape used in Split operation in compsolid is a full compsolid.
  87
  88 .. figure:: images/recover_res_compound.png
  89    :align: center
  90
  91    Recover a compsolid
  92
  93 **See also** a sample TUI script of ref:`tui_recover_compound` operation.