0030780: [Regression to 7.3.0] BRepMesh fails triangulating one face of the shape
[occt.git] / src / IMeshTools / IMeshTools_Parameters.hxx
1 // Created on: 2016-04-07
2 // Copyright (c) 2016 OPEN CASCADE SAS
3 // Created by: Oleg AGASHIN
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _IMeshTools_Parameters_HeaderFile
17 #define _IMeshTools_Parameters_HeaderFile
18
19 #include <Precision.hxx>
20
21 //! Structure storing meshing parameters
22 struct IMeshTools_Parameters {
23
24   //! Default constructor
25   IMeshTools_Parameters ()
26     :
27     Angle(0.5),
28     Deflection(0.001),
29     AngleInterior(-1.0),
30     DeflectionInterior(-1.0),
31     MinSize (-1.0),
32     InParallel (Standard_False),
33     Relative (Standard_False),
34     InternalVerticesMode (Standard_True),
35     ControlSurfaceDeflection (Standard_True),
36     CleanModel (Standard_True),
37     AdjustMinSize (Standard_False)
38   {
39   }
40
41   //! Returns factor used to compute default value of MinSize 
42   //! (minimum mesh edge length) from deflection
43   static Standard_Real RelMinSize()
44   {
45     return 0.1;
46   }
47
48   //! Angular deflection used to tessellate the boundary edges
49   Standard_Real                                    Angle;
50
51   //!Linear deflection used to tessellate the boundary edges
52   Standard_Real                                    Deflection;
53   
54   //! Angular deflection used to tessellate the face interior
55   Standard_Real                                    AngleInterior;
56
57   //! Linear deflection used to tessellate the face interior
58   Standard_Real                                    DeflectionInterior;
59   
60   //! Minimal allowed size of mesh element
61   Standard_Real                                    MinSize;
62
63   //! Switches on/off multi-thread computation
64   Standard_Boolean                                 InParallel;
65
66   //! Switches on/off relative computation of edge tolerance<br>
67   //! If true, deflection used for the polygonalisation of each edge will be 
68   //! <defle> * Size of Edge. The deflection used for the faces will be the 
69   //! maximum deflection of their edges.
70   Standard_Boolean                                 Relative;
71
72   //! Mode to take or not to take internal face vertices into account
73   //! in triangulation process
74   Standard_Boolean                                 InternalVerticesMode;
75
76   //! Parameter to check the deviation of triangulation and interior of
77   //! the face
78   Standard_Boolean                                 ControlSurfaceDeflection;
79
80   //! Cleans temporary data model when algorithm is finished.
81   Standard_Boolean                                 CleanModel;
82
83   //! Enables/disables local adjustment of min size depending on edge size.
84   //! Disabled by default.
85   Standard_Boolean                                 AdjustMinSize;
86 };
87
88 #endif