Salome HOME
Task 3.3. Recovering Compsolids and Compounds
[modules/shaper.git] / src / FeaturesPlugin / doc / recoverFeature.rst
index 8370449c051f83c4acdd7a53a2d0a64e99e8e943..18ae83f59d68a0675b951833df75adf60cb54f0f 100644 (file)
@@ -1,9 +1,85 @@
- Recover
- =======
+Recover
+=======
 
+**Recover** feature restores some objects used in previous operations.
 
-.. image:: images/Recover.png
-  :align: center
+To recover in the active part:
+
+#. select in the Main Menu *Features - > Recover* item or
+#. click **Recover** button in the toolbar
+
+.. image:: images/recover.png
+   :align: center
 
 .. centered::
-  Recover operation
+   **Recover** button
+
+The feature has the following options:
+
+.. image:: images/recover_default_32x32.png
+   :align: left
+restore only the objects used in the operation
+
+.. image:: images/recover_compound_32x32.png
+   :align: left
+restore full compound/compsolid if the operation used one or more of its sub-shapes
+
+
+Recover objects
+---------------
+
+.. image:: images/recover_mode_default.png
+   :align: center
+
+.. centered::
+   Recover objects used in operation
+
+- **Feature** field contains one of the previous operations;
+- **List of recovered** objects contains all the shapes used in the operation. Need to enable checkbox to restore a shape.
+
+**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results])*
+
+**Arguments**: part + the name of the feature + list of results used in the feature.
+
+Result
+""""""
+
+Result of restoring the shape used in Split operation in compsolid is a single solid.
+
+.. image:: images/recover_res_default.png
+   :align: center
+
+.. centered::
+   Recover a solid
+
+**See also** a sample TUI script of ref:`tui_recover_default` operation.
+
+
+Recover top-level objects
+-------------------------
+
+.. image:: images/recover_mode_compound.png
+   :align: center
+
+.. centered::
+   Recover top-level compounds/compsolids of objects used in operation
+
+- **Feature** field contains one of the previous operations;
+- **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.
+
+**TUI Command**: *model.addRecover(Part_doc, feature, [recovering_results], True)*
+
+**Arguments**: part + the name of the feature + list of results used in the feature + *True* to specify restoring compounds.
+
+Result
+""""""
+
+Result of restoring the shape used in Split operation in compsolid is a full compsolid.
+
+.. image:: images/recover_res_compound.png
+   :align: center
+
+.. centered::
+   Recover a compsolid
+
+**See also** a sample TUI script of ref:`tui_recover_compound` operation.