src/BOPAlgo/BOPAlgo_GlueEnum.hxx

   1 // Created by: Eugeny MALTCHIKOV
   2 // Copyright (c) 2016 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _BOPAlgo_GlueEnum_HeaderFile
  16 #define _BOPAlgo_GlueEnum_HeaderFile
  17
  18 //! The Enumeration describes an additional option for the algorithms
  19 //! in the Boolean Component such as General Fuse, Boolean operations,
  20 //! Section operation, Maker Volume and Cells Builder algorithms.
  21 //!
  22 //! The Gluing options have been designed to speed up the computation
  23 //! of the interference among arguments of the operations on special cases,
  24 //! in which the arguments may be overlapping but do not have real intersections
  25 //! between their sub-shapes.
  26 //!
  27 //! This option cannot be used on the shapes having real intersections,
  28 //! like intersection vertex between edges, or intersection vertex between
  29 //! edge and a face or intersection line between faces.
  30 //!
  31 //! There are two possibilities of overlapping shapes:
  32 //! 1. The shapes can be partially coinciding - the faces do not have
  33 //!    intersection curves, but overlapping. The faces of such arguments will
  34 //!    be split during the operation;
  35 //! 2. The shapes can be fully coinciding - there should be no partial
  36 //!    overlapping of the faces, thus no intersection of type EDGE/FACE at all.
  37 //!    In such cases the faces will not be split during the operation.
  38 //!
  39 //! Even though there are no real intersections on such cases without Gluing options the algorithm
  40 //! will still intersect the sub-shapes of the arguments with interfering bounding boxes.
  41 //!
  42 //! The performance improvement in gluing mode is achieved by excluding
  43 //! the most time consuming computations according to the given Gluing parameter:
  44 //! 1. Computation of FACE/FACE intersections for partial coincidence;
  45 //! 2. And computation of VERTEX/FACE, EDGE/FACE and FACE/FACE intersections for full coincidence.
  46 //!
  47 //! By setting the Gluing option for the operation user should guarantee
  48 //! that the arguments are really coinciding. The algorithms do not check this itself.
  49 //! Setting inappropriate option for the operation is likely to lead to incorrect result.
  50 //!
  51 //! There are following items in the enumeration:
  52 //! BOPAlgo_GlueOff - default value for the algorithms, Gluing is switched off;
  53 //! BOPAlgo_GlueShift - Glue option for shapes with partial coincidence;
  54 //! BOPAlgo_GlueFull - Glue option for shapes with full coincidence.
  55 //!
  56
  57 enum BOPAlgo_GlueEnum
  58 {
  59   BOPAlgo_GlueOff,
  60   BOPAlgo_GlueShift,
  61   BOPAlgo_GlueFull
  62 };
  63
  64 #endif // _BOPAlgo_GlueEnum_HeaderFile