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