doc/salome/gui/GEOM/input/inspect_object_operation.doc

   1 /*!
   2
   3 \page inspect_object_operation_page Inspect Object
   4
   5 This operation allows browsing the contents of the selected shape.
   6
   7 To <b>Inspect Object</b>, in the <b>Main Menu</b> select <b>Measures - > Inspect Object</b>.
   8
   9 The dialog can be used in two modes. The first one is a tree view mode:
  10 \image html inspect_object.png "Dialog in the tree view mode"
  11
  12 This is a default mode that allows to inspect an object in the form of tree
  13 starting from the shape itself. Its children are its direct sub-shapes that
  14 have they own children as sub-shapes etc. till most very base sub-shapes,
  15 i.e. vertices.
  16
  17 The second mode is a filtering one. It is activated when the user selects
  18 <b>Tolerance filter</b> check box:
  19 \image html inspect_object2.png "Dialog in the filtering mode"
  20
  21 In this mode the user can check the type of sub-shapes to work with using
  22 the radio-buttons. The type can be either \b Vertex, \b Edge or \b Face.
  23 Then the user choses a tolerance criterion to be applied to filter out
  24 sub-shapes. It is possible to chose one of the following values:
  25 - \b > - greater than (default value)
  26 - \b >= - greater than or equal to
  27 - \b < - lower than
  28 - \b <= - lower than or equal to
  29
  30 The last parameter to be chosen is the tolerance value. The result is the shapes
  31 of a certain type that satisfy the defined tolerance criterion. E.g. if the user
  32 chooses \b Face, criterion \b > and tolerance value equal to \b 1.e-6 the faces
  33 with the tolerance greater than \b 1.e-6 are displayed.
  34
  35 It is possible to set maximal and minimal value of the tolerance using the
  36 buttons <b>Max value</b> and <b>Min value</b>. These values are displayed in
  37 the labels <b>Max :</b> and <b>Min :</b>
  38
  39 In this dialog never mind of its mode it is possible to:
  40 - Click on the "selection" button and select an object to inspect in the Object Browser or in the viewer.
  41 - Show/hide sub-shape(s) in the 3D viewer, by pressing "eye" icon in the first column of the tree view.
  42 - Show/hide all sub-shapes in the tree, by pressing "eye" icon in the first column of the tree view header or
  43   by pressing <b>Show all</b>/<b>Hide all</b> buttons.
  44 - Rename the selected sub-shape by double-clicking on the item or pressing <F2> key.
  45 - Show the selected sub-shape(s) in the 3D viewer by pressing <b>Show Selected</b> button.
  46 - Show the selected sub-shape(s) in the 3D viewer and erase all currently shown objects by pressing <b>Show Only Selected</b> button.
  47 - Hide the selected sub-shape(s) from the 3D viewer by pressing <b>Hide Selected</b> button.
  48 - Publish the selected sub-shapes in the study, by pressing <b>Publish Selected</b> button.
  49 - Close dialog box, by pressing <b>Close</b> button.
  50
  51 \n <b>TUI Command:</b>
  52
  53 A command to filter sub-shapes is defined:
  54
  55 <em>geompy.GetSubShapesWithTolerance(theShape, theShapeType, theCondition, theTolerance),</em> \n
  56 where \n
  57 \em theShape is the shape to be exploded. \n
  58 \em theShapeType is the type of sub-shapes to be returned. Can have
  59     the values \b GEOM.FACE, \b GEOM.EDGE and \b GEOM.VERTEX only.\n
  60 \em theCondition is the condition type (the value of GEOM.comparison_condition emuneration).\n
  61 \em theTolerance is the tolerance filter.
  62
  63 See also a \ref swig_GetSubShapesWithTolerance "TUI example".
  64
  65 */