include/opencascade/BOPAlgo_GlueEnum.hxx

0001 // Created by: Eugeny MALTCHIKOV
0002 // Copyright (c) 2016 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef _BOPAlgo_GlueEnum_HeaderFile
0016 #define _BOPAlgo_GlueEnum_HeaderFile
0017
0018 //! The Enumeration describes an additional option for the algorithms
0019 //! in the Boolean Component such as General Fuse, Boolean operations,
0020 //! Section, Maker Volume, Splitter and Cells Builder algorithms.<br>
0021 //!
0022 //! The Gluing options have been designed to speed up the computation
0023 //! of the interference among arguments of the operations on special cases,
0024 //! in which the arguments may be overlapping but do not have real intersections
0025 //! between their sub-shapes.<br>
0026 //!
0027 //! This option cannot be used on the shapes having real intersections,
0028 //! like intersection vertex between edges, or intersection vertex between
0029 //! edge and a face or intersection line between faces.<br>
0030 //!
0031 //! There are two possibilities of overlapping shapes:<br>
0032 //! 1. The shapes can be partially coinciding - the faces do not have
0033 //!    intersection curves, but overlapping. The faces of such arguments will
0034 //!    be split during the operation;<br>
0035 //! 2. The shapes can be fully coinciding - there should be no partial
0036 //!    overlapping of the faces, thus no intersection of type EDGE/FACE at all.
0037 //!    In such cases the faces will not be split during the operation.<br>
0038 //!
0039 //! Even though there are no real intersections on such cases without Gluing options the algorithm
0040 //! will still intersect the sub-shapes of the arguments with interfering bounding boxes.<br>
0041 //!
0042 //! The performance improvement in gluing mode is achieved by excluding
0043 //! the most time consuming computations according to the given Gluing parameter:<br>
0044 //! 1. Computation of FACE/FACE intersections for partial coincidence;<br>
0045 //! 2. And computation of VERTEX/FACE, EDGE/FACE and FACE/FACE intersections for full coincidence.<br>
0046 //!
0047 //! By setting the Gluing option for the operation user should guarantee
0048 //! that the arguments are really coinciding. The algorithms do not check this itself.
0049 //! Setting inappropriate option for the operation is likely to lead to incorrect result.<br>
0050 //!
0051 //! There are following items in the enumeration:<br>
0052 //! **BOPAlgo_GlueOff** - default value for the algorithms, Gluing is switched off;<br>
0053 //! **BOPAlgo_GlueShift** - Glue option for shapes with partial coincidence;<br>
0054 //! **BOPAlgo_GlueFull** - Glue option for shapes with full coincidence.
0055 //!
0056 enum BOPAlgo_GlueEnum
0057 {
0058   BOPAlgo_GlueOff,
0059   BOPAlgo_GlueShift,
0060   BOPAlgo_GlueFull
0061 };
0062
0063 #endif // _BOPAlgo_GlueEnum_HeaderFile