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 quadrangle faces);
  12 - Each quadrangle face is a face that has 1 wire with 4 edges. If there are
  13 more than 4 edges in a single wire and C1 continuity mode is switched on,
  14 a face is quadrangular if it has 4 bounds of C1 continuity.
  15 - Blocks can be connected only via an entire quadrangle face or an entire edge;
  16 - The compound should be connected;
  17 - Each couple of connecting quadrangle faces should be glued.
  18
  19
  20 In this dialog:
  21
  22 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
  23 - <b>Use C1 criterion</b> - option that shitches on/off the C1 continuity mode.
  24 - <b>Angular Tolerance</b> - angular tolerance to check C1 continuity between neighbor edges in a wire.
  25 - \b Errors list informs of possible errors, for example:
  26         - Not a block;
  27         - Not glued;
  28         - Not connected;
  29         - Extra or degenerated edge.
  30 - <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.
  31
  32
  33 \n <b>TUI Command:</b>
  34 <em>geompy.CheckCompoundOfBlocks(Compound, theIsUseC1 = False, theAngTolerance = 1.e-12).</em> Checks if the shape
  35 is a valid compound of blocks. If it is true, then the validity flag
  36 is returned, and encountered errors are printed in the python console.
  37
  38 See also a \ref tui_check_compound_of_blocks_page "TUI example".
  39
  40
  41 */