0025113: Mesh - Progress indication and user break functionality for BRepMesh component
[occt.git] / src / BRepMesh / BRepMesh_IncrementalMesh.hxx
1 // Copyright (c) 2013 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BRepMesh_IncrementalMesh_HeaderFile
15 #define _BRepMesh_IncrementalMesh_HeaderFile
16
17 #include <BRepMesh_DiscretRoot.hxx>
18 #include <IMeshTools_Parameters.hxx>
19 #include <IMeshTools_Context.hxx>
20
21 //! Builds the mesh of a shape with respect of their 
22 //! correctly triangulated parts 
23 class BRepMesh_IncrementalMesh : public BRepMesh_DiscretRoot
24 {
25 public: //! @name mesher API
26
27   //! Default constructor
28   Standard_EXPORT BRepMesh_IncrementalMesh();
29
30   //! Destructor
31   Standard_EXPORT virtual ~BRepMesh_IncrementalMesh();
32
33   //! Constructor.
34   //! Automatically calls method Perform.
35   //! @param theShape shape to be meshed.
36   //! @param theLinDeflection linear deflection.
37   //! @param isRelative if TRUE deflection used for discretization of 
38   //! each edge will be <theLinDeflection> * <size of edge>. Deflection 
39   //! used for the faces will be the maximum deflection of their edges.
40   //! @param theAngDeflection angular deflection.
41   //! @param isInParallel if TRUE shape will be meshed in parallel.
42   Standard_EXPORT BRepMesh_IncrementalMesh(const TopoDS_Shape&    theShape,
43                                            const Standard_Real    theLinDeflection,
44                                            const Standard_Boolean isRelative = Standard_False,
45                                            const Standard_Real    theAngDeflection = 0.5,
46                                            const Standard_Boolean isInParallel = Standard_False);
47
48   //! Constructor.
49   //! Automatically calls method Perform.
50   //! @param theShape shape to be meshed.
51   //! @param theParameters - parameters of meshing
52   Standard_EXPORT BRepMesh_IncrementalMesh(const TopoDS_Shape&          theShape,
53                                            const IMeshTools_Parameters& theParameters,
54                                            const Message_ProgressRange& theRange = Message_ProgressRange());
55
56   //! Performs meshing ot the shape.
57   Standard_EXPORT virtual void Perform(const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
58
59   //! Performs meshing using custom context;
60   Standard_EXPORT void Perform(const Handle(IMeshTools_Context)& theContext,
61                                const Message_ProgressRange& theRange = Message_ProgressRange());
62   
63 public: //! @name accessing to parameters.
64
65   //! Returns meshing parameters
66   inline const IMeshTools_Parameters& Parameters() const
67   {
68     return myParameters;
69   }
70
71   //! Returns modifiable meshing parameters
72   inline IMeshTools_Parameters& ChangeParameters()
73   {
74     return myParameters;
75   }
76
77   //! Returns modified flag.
78   inline Standard_Boolean IsModified() const
79   {
80     return myModified;
81   }
82   
83   //! Returns accumulated status flags faced during meshing.
84   inline Standard_Integer GetStatusFlags() const
85   {
86     return myStatus;
87   }
88   
89 private:
90
91   //! Initializes specific parameters
92   inline void initParameters()
93   {
94     if (myParameters.DeflectionInterior < Precision::Confusion())
95     {
96       myParameters.DeflectionInterior = myParameters.Deflection;
97     }
98
99     if (myParameters.MinSize < Precision::Confusion())
100     {
101       myParameters.MinSize =
102         Max(IMeshTools_Parameters::RelMinSize() * Min(myParameters.Deflection,
103                                                       myParameters.DeflectionInterior),
104             Precision::Confusion());
105     }
106
107     if (myParameters.AngleInterior < Precision::Angular())
108     {
109       myParameters.AngleInterior = 2.0 * myParameters.Angle;
110     }
111   }
112
113 public: //! @name plugin API
114
115   //! Plugin interface for the Mesh Factories.
116   //! Initializes meshing algorithm with the given parameters.
117   //! @param theShape shape to be meshed.
118   //! @param theLinDeflection linear deflection.
119   //! @param theAngDeflection angular deflection.
120   //! @param[out] theAlgo pointer to initialized algorithm.
121   Standard_EXPORT static Standard_Integer Discret(const TopoDS_Shape&    theShape,
122                                                   const Standard_Real    theLinDeflection,
123                                                   const Standard_Real    theAngDeflection,
124                                                   BRepMesh_DiscretRoot* &theAlgo);
125   
126   //! Returns multi-threading usage flag set by default in 
127   //! Discret() static method (thus applied only to Mesh Factories).
128   Standard_EXPORT static Standard_Boolean IsParallelDefault();
129   
130   //! Setup multi-threading usage flag set by default in 
131   //! Discret() static method (thus applied only to Mesh Factories).
132   Standard_EXPORT static void SetParallelDefault(const Standard_Boolean isInParallel);
133
134   DEFINE_STANDARD_RTTI_INLINE(BRepMesh_IncrementalMesh, BRepMesh_DiscretRoot)
135
136 protected:
137
138   IMeshTools_Parameters myParameters;
139   Standard_Boolean      myModified;
140   Standard_Integer      myStatus;
141 };
142
143 #endif