doc/salome/gui/GEOM/input/reduce_study.doc

   1 /*!
   2
   3 \page reduce_study_page Reduce Study
   4
   5 The user sometimes needs to keep in the study only some objects that
   6 present the final result(s) of the design operations and to delete all
   7 other objects which do not contribute to these results.
   8
   9 The feature is especially useful when the user designs the whole model
  10 through the GUI and wants to generate simplified "clean" Python dump only
  11 at the end of the model construction with no "useless" objects in the
  12 %GEOM module.
  13
  14 User can open dialog box by selecting desirable object(s) in Object
  15 Browser or OCC Viewer and calling "Reduce study" popup item.
  16
  17 \image html reduce_study_dialog.png
  18
  19 <ul>
  20
  21 <li><b> Objects to be kept</b> - objects will be kept in the study after
  22 applying operation of reduce study. The list of objects being selected by
  23 the user are highlighted in bold font.
  24 \n Moreover user can show and hide object(s) in current OCC Viewer using
  25 "eye" icons near each item of tree. It's possible to click on "eye" icon
  26 in the head of tree in order to show/hide all objects.</li>
  27
  28 <li><b> Objects to be removed</b> - objects will be deleted by the
  29 function if it is applied.</li>
  30
  31 <li><b> Intermediate objects</b> - allows to choose future action with
  32 the objects, being in the operations chains to produce final objects:
  33 <ul>
  34 <li>Keep - object(s) will be kept in the study;</li>
  35 <li>Unpublish - object(s) will be automatically unpublished (hidden)
  36 from the study;</li>
  37 <li>Remove - object(s) will be removed from the study. Since using of
  38 this option can lead to the broken Dump Python, the warning message
  39 will be shown to the user.</li>
  40 </ul>
  41 </li>
  42
  43 <li><b> Sub-objects</b> - allows to choose the same operations for
  44 sub-objects of selected item(s): keep, unpublish or remove.</li>
  45
  46 <li><b> Remove empty folders</b> - if this option is checked, all folders,
  47 which will become empty after removal of the unused objects from the
  48 study, will be also removed; otherwise, empty folders will be kept.</li>
  49
  50 <li><b> Soft removal</b> - if this option is checked, operation will just
  51 unpublish the redundant objects from the study instead of their hard removal.
  52 \n Soft removal would keep all the data in the study to give the user
  53 chance to rollback this operation using "Publish Objects" dialog box.</li>
  54
  55 </ul>
  56 */