src/FeaturesPlugin/doc/recoverFeature.rst

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