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 and improves the shape to include only valid blocks.
   7
   8 \image html measures10.png
   9
  10 To be considered as a compound of blocks, the given shape must satisfy the
  11 following conditions:
  12 - Each element of the compound should be a Block, i.e. have 6 quadrangle faces;
  13 - Each quadrangle face should have one wire with four edges. If there are
  14 more than four edges in a single wire and C1 continuity mode is switched on,
  15 a face is quadrangular if it has four bounds with C1 continuity.
  16 - Blocks can be connected only via an entire quadrangle face or an entire edge;
  17 - The compound should be connected;
  18 - Each couple of connecting quadrangle faces should be glued.
  19
  20
  21 In this dialog:
  22
  23 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
  24 - <b>Use C1 criterion</b> - option switches on/off the C1 continuity mode.
  25 - <b>Angular Tolerance</b> - angular tolerance to check C1 continuity between neighbor edges in a wire.
  26 - \b Errors list informs of possible errors, for example:
  27         - Not a block;
  28         - Not glued;
  29         - Not connected;
  30         - Extra or degenerated edge.
  31 - <b>Incriminated Sub-shapes</b> field outputs the list of sub-shapes that cause problem.
  32 - \b Apply and <b>Apply and Close</b> buttons launch the improvement process
  33 and publish the result shape, which includes valid blocks only. The
  34 algorithm tries to:
  35    - remove seam and degenerated edges from surfaces of revolution;
  36    - re-approximate surfaces to exclude singularities on boundaries;
  37    - unite edges and faces;
  38    - glue faces.
  39
  40
  41 \n <b>TUI Command:</b>
  42 <em>geompy.CheckCompoundOfBlocks(Compound, theIsUseC1 = False, theAngTolerance = 1.e-12).</em> Checks if the shape
  43 is a valid compound of blocks. If it is true, then the validity flag
  44 is returned, and encountered errors are printed in the python console.
  45
  46 See also a \ref tui_check_compound_of_blocks_page "TUI example".
  47
  48
  49 */