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 Checks whether a shape is a compound of glued blocks. To be
   6 considered as a compound of blocks, the given shape must satisfy the
   7 following conditions:
   8 <ul>
   9 <li>Each element of the compound should be a Block (6 faces and 12 edges);</li>
  10 <li>A connection between two Blocks should be an entire quadrangle face or an entire edge;</li>
  11 <li>The compound should be connected;</li>
  12 <li>Two quadrangle faces should be glued.</li>
  13 </ul>
  14
  15 \n Informs of the following possible errors:
  16 <ul>
  17 <li>not a block;</li>
  18 <li>not glued;</li>
  19 <li>not connected;</li>
  20 <li>extra or degenerated edge.</li>
  21 </ul>
  22
  23 \n <b>Result:</b> Boolean; highlight in the viewer.
  24 \n <b>TUI Command:</b>
  25 <em>geompy.CheckCompoundOfBlocks(Compound).</em> Checks if the shape
  26 is a valid compound of blocks. If it is true, then the validity flag
  27 is returned, and encountered errors are printed in the python console.
  28
  29 See also a \ref tui_check_compound_of_blocks_page "TUI example".
  30
  31 \image html measures10.png
  32
  33 */