doc/salome/gui/GEOM/input/check_compound_of_blocks.doc

   1 /*!
   2
   3 \page check_compound_of_blocks_page Check Compound of Blocks
   4
   5 This operation checks whether a shape is a compound of glued blocks.
   6
   7 \image html measures10.png
   8
   9 To be considered as a compound of blocks, the given shape must satisfy the
  10 following conditions:
  11 - Each element of the compound should be a Block (6 faces and 12 edges);
  12 - Blocks can be connected only via an entire quadrangle face or an entire edge;
  13 - The compound should be connected;
  14 - Each couple of connecting quadrangle faces should be glued.
  15
  16
  17 In this dialog:
  18
  19 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
  20 - \b Errors list informs of possible errors, for example:.
  21         - Not a block;
  22         - Not glued;
  23         - Not connected;
  24         - Extra or degenerated edge.
  25 - <b>Incriminated Sub-shapes</b> field outputs the list of sub-shapes that cause problem. It is possible to select them in the list and publish in the study for further analysis by clicking \b Apply or <b>Apply and Close</b> button.
  26
  27
  28 \n <b>TUI Command:</b>
  29 <em>geompy.CheckCompoundOfBlocks(Compound).</em> Checks if the shape
  30 is a valid compound of blocks. If it is true, then the validity flag
  31 is returned, and encountered errors are printed in the python console.
  32
  33 See also a \ref tui_check_compound_of_blocks_page "TUI example".
  34
  35
  36 */