doc/salome/gui/SMESH/input/selection_filter_library.doc

   1 /*!
   2
   3 \page selection_filter_library_page Selection filter library
   4
   5 \n Selection filter library is a powerful tool enabling to create
   6 filters to be used on meshes. You can access to it from the Main Menu
   7 via <b>Tools / Selection filter library</b>.
   8
   9 \image html selectionfilterlibrary.png
  10
  11 <b>Library file name</b> shows the path and the file name where your
  12 filters will be stored. By clicking the <em>Browse</em> button you can load an
  13 existing filter library.
  14 \n <b>Names of filters</b> lists the filters created or uploaded for
  15 the current study. You can \b Add or \b Delete filters.
  16 \n In <b>Filter name</b> box you can specify the name for your
  17 filter. By default it is prefixed with the corresponding entity type.
  18 \n Each filter can be applicable to \b Nodes, \b Edges, \b Faces or \b
  19 Volumes. You can combine many criteria in one filter, but they all
  20 must be of the same <b>Entity type</b>.
  21 \n The \b Add button creates a new criterion at the end of the list of
  22 criteria. The \b Insert button creates a new criterion before the
  23 selected criterion. The \b Remove button deletes the selected
  24 criterion. The \b Clear button deletes all criteria.
  25 \n Each <b>Entity type</b> has its specific list of criteria, however all
  26 filters have common syntax. For each criterion you should specify the
  27 <b>Threshold Value</b> and whether we search for the elements that should be
  28 \b More, \b Less or \b Equal to this \b Value. You should also specify if the
  29 criterion is \b Unary or \b Binary.
  30 \n Some criteria should have the additional parameter of \b Tolerance.
  31
  32 When we create a <b>Standalone Group</b> using filters (for this click
  33 <b>Set Filters</b> button in the <b>Create Group</b> menu), the menu
  34 for setting filters looks a bit differently. Toggling <b>Insert filter
  35 in viewer</b> checkbox enables to preview the group selected with your
  36 current filter in the viewer.
  37 \n In the \b Source field you choose if the filter will be applied to
  38 the whole \b Mesh, the <b>Initial Selection</b> or the <b>Current Group</b>.
  39 \n <b>Copy from...</b> button gives you a possibility to load an
  40 existing filter from <b>Selection filter library</b> and <b>Add
  41 to...</b> button gives you a possibility to save your current filter
  42 in the Library.
  43
  44 \image html a-filteronedges.png
  45
  46 */