0026106: BRepMesh - revision of data model
[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     MinSize (-1.0),
30     InParallel (Standard_False),
31     Relative (Standard_False),
32     InternalVerticesMode (Standard_True),
33     ControlSurfaceDeflection (Standard_True),
34     CleanModel(Standard_True)
35   {
36   }
37
38   //! Returns factor used to compute default value of MinSize 
39   //! (minimum mesh edge length) from deflection
40   static Standard_Real RelMinSize()
41   {
42     return 0.1;
43   }
44
45   //! Angular deflection
46   Standard_Real                                    Angle;
47
48   //! Deflection
49   Standard_Real                                    Deflection;
50
51   //! Minimal allowed size of mesh element
52   Standard_Real                                    MinSize;
53
54   //! Switches on/off multi-thread computation
55   Standard_Boolean                                 InParallel;
56
57   //! Switches on/off relative computation of edge tolerance<br>
58   //! If true, deflection used for the polygonalisation of each edge will be 
59   //! <defle> * Size of Edge. The deflection used for the faces will be the 
60   //! maximum deflection of their edges.
61   Standard_Boolean                                 Relative;
62
63   //! Mode to take or not to take internal face vertices into account
64   //! in triangulation process
65   Standard_Boolean                                 InternalVerticesMode;
66
67   //! Parameter to check the deviation of triangulation and interior of
68   //! the face
69   Standard_Boolean                                 ControlSurfaceDeflection;
70
71   //! Cleans temporary data model when algorithm is finished.
72   Standard_Boolean                                 CleanModel;
73 };
74
75 #endif