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 that 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.</li>
  24
  25 <li><b> Objects to be removed</b> - objects that will be deleted.</li>
  26
  27 \note Mentioned views provide possibility to show/hide object(s) in
  28 current Viewer using "eye" icon near each item of tree. Also user can
  29 show/hide ALL objects in tree by clicking "eye" icon in the head of tree view.
  30
  31 <li><b> Intermediate objects</b> group box allows to choose an action
  32 that will be performed with the objects that took part in the operations
  33 chain to produce the selected object(s):
  34 <ul>
  35 <li>Keep - object(s) will be kept in the study;</li>
  36 <li>Unpublish - object(s) will be unpublished (hidden) from the study;</li>
  37 <li>Remove - object(s) will be removed from the study. \note Since use of
  38 this option can lead to the broken Dump Python script, the warning message
  39 will be shown at the operation commiting to confirm/reject removing
  40 intermediate objects.</li>
  41 </ul>
  42 </li>
  43
  44 <li><b> Sub-objects</b> group box allows to choose the same operations for
  45 sub-objects of selected item(s): keep, unpublish or remove.</li>
  46
  47 <li><b> Remove empty folders</b> - if this option is checked, then all folders,
  48 which will become empty after removing unused objects from the study,
  49 will be also removed; otherwise, empty folders will be kept.</li>
  50
  51 <li><b> Soft removal</b> - if this option is checked, operation will just
  52 unpublish the redundant objects from the study instead of their hard delete.
  53 \n Soft removal would keep all the data in the study to give the user a
  54 chance to revert this operation using \ref publish_hidden_objects
  55 "Publish Objects" dialog box.</li>
  56
  57 </ul>
  58 */