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

   1 /*!
   2
   3 \page reduce_study_page Reduce Study
   4
   5 It can be sometimes necessary to keep in the study only the 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 This is especially useful when the model is designed using the GUI
  10 and it is necessary to generate a simplified "clean" Python dump without "useless" objects
  11 at the end of the model construction.
  12
  13 This feature can be activated by selecting the desirable object(s) in Object
  14 Browser or OCC Viewer and calling "Reduce study" context item.
  15
  16 \image html reduce_study_dialog.png
  17
  18 <ul>
  19
  20 <li><b> Objects to be kept</b> - objects that will be kept in the study after
  21 applying reduce study operation. The objects selected by
  22 the user are highlighted in bold font.</li>
  23
  24 <li><b> Objects to be removed</b> - objects that will be deleted.</li>
  25
  26 \note It is possible to show/hide object(s) in the
  27 current Viewer using "eye" icon next to each tree item.
  28 ALL objects in the tree can be shown/hidden by clicking the "eye" icon in the head of the tree view.
  29
  30 <li><b> Intermediate objects</b> group box allows choosing what should be done with the objects that are used to produce the selected object(s):
  31 <li><b> Sub-objects</b> group box allows choosing the same operations for
  32 sub-objects of the selected object(s).</li>
  33
  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 cause a broken Dump Python script, the warning message
  39 is shown confirm/reject removing intermediate objects.</li>
  40 </ul>
  41 </li>
  42
  43
  44 <li><b> Remove empty folders</b> - if this option is checked, all folders,
  45 which will become empty after removing unused objects from the study,
  46 will be also removed; otherwise, empty folders will be kept.</li>
  47
  48 <li><b> Soft removal</b> - if this option is checked, the operation will
  49 unpublish the redundant objects from the study instead of deleting them.
  50 \n So, soft removal keeps all data in the study to give the user a
  51 chance to revert this operation using \ref publish_hidden_objects
  52 "Publish Objects" dialog box.</li>
  53
  54 </ul>
  55 */