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