0023631: Infinite memory consumption in BRepMesh
[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 <Standard.hxx>
18 #include <Standard_DefineHandle.hxx>
19
20 #include <Handle_BRepMesh_FastDiscret.hxx>
21 #include <TopTools_MapOfShape.hxx>
22 #include <TopTools_DataMapOfShapeReal.hxx>
23 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
24 #include <Bnd_Box.hxx>
25 #include <BRepMesh_DiscretRoot.hxx>
26 #include <BRepMesh_PDiscretRoot.hxx>
27
28 #include <vector>
29
30 class BRepMesh_FastDiscret;
31 class TopoDS_Shape;
32 class TopoDS_Edge;
33 class TopoDS_Face;
34
35 //! Builds the mesh of a shape with respect of their <br>
36 //! correctly triangulated parts <br>
37 //! <br>
38 class BRepMesh_IncrementalMesh : public BRepMesh_DiscretRoot {
39
40 public:
41
42   Standard_EXPORT   BRepMesh_IncrementalMesh();
43
44   Standard_EXPORT virtual ~BRepMesh_IncrementalMesh();
45
46   //! If the boolean flag <isRelative> is TRUE, the <br>
47   //! deflection used for the polygonalisation of <br>
48   //! each edge will be <theLinDeflection> * Size of Edge. <br>
49   //! the deflection used for the faces will be the maximum <br>
50   //! deflection of their edges. <br>
51   Standard_EXPORT BRepMesh_IncrementalMesh(const TopoDS_Shape&    theShape,
52                                            const Standard_Real    theLinDeflection,
53                                            const Standard_Boolean isRelative       = Standard_False,
54                                            const Standard_Real    theAngDeflection = 0.5,
55                                            const Standard_Boolean isInParallel     = Standard_False);
56   
57   Standard_EXPORT void SetRelative(const Standard_Boolean theFlag);
58   
59   Standard_EXPORT Standard_Boolean Relative() const;
60   
61   Standard_EXPORT virtual void Perform();
62
63   //! Builds the incremental mesh of the shape <br>
64   Standard_EXPORT void Update(const TopoDS_Shape& theShape);
65   
66   Standard_EXPORT Standard_Boolean IsModified() const;
67   
68   Standard_EXPORT Standard_Integer GetStatusFlags() const;
69   
70   //! Request algorithm to launch in multiple threads to improve performance. <br>
71   Standard_EXPORT void SetParallel(const Standard_Boolean isInParallel);
72   
73   //! Returns the multi-threading usage flag. <br>
74   Standard_EXPORT Standard_Boolean IsParallel() const;
75   
76   //! Plugin interface for the Mesh Factories. <br>
77   Standard_EXPORT static Standard_Integer Discret(const TopoDS_Shape&    theShape,
78                                                   const Standard_Real    theLinDeflection,
79                                                   const Standard_Real    theAngDeflection,
80                                                   BRepMesh_PDiscretRoot& theAlgo);
81   
82   //! Returns multi-threading usage flag set by default in <br>
83   //! Discret() static method (thus applied only to Mesh Factories). <br>
84   Standard_EXPORT static Standard_Boolean IsParallelDefault();
85   
86   //! Setup multi-threading usage flag set by default in <br>
87   //! Discret() static method (thus applied only to Mesh Factories). <br>
88   Standard_EXPORT static void SetParallelDefault(const Standard_Boolean isInParallel) ;
89
90
91   DEFINE_STANDARD_RTTI(BRepMesh_IncrementalMesh)
92
93 protected:
94
95   Standard_EXPORT virtual void Init();
96
97   //! Collects faces suitable for meshing.
98   Standard_EXPORT void collectFaces();
99
100 protected:
101
102   Standard_Boolean                          myRelative;
103   Standard_Boolean                          myInParallel;
104   TopTools_MapOfShape                       myMap;
105   Handle_BRepMesh_FastDiscret               myMesh;
106   Standard_Boolean                          myModified;
107   TopTools_DataMapOfShapeReal               mymapedge;
108   TopTools_IndexedDataMapOfShapeListOfShape myancestors;
109   Standard_Real                             mydtotale;
110   Bnd_Box                                   myBox;
111   Standard_Integer                          myStatus;
112   std::vector<TopoDS_Face>                  myFaces;
113
114 private:
115   //! Checks is the shape to be meshed has correct poly data, <br>
116   //! i.e. PolygonOnTriangulation of particular edge connected <br>
117   //! to the same Triangulation data structure as stored inside <br>
118   //! a parent face. <br>
119   Standard_Boolean isCorrectPolyData();
120
121   //! Locate a correct discretisation if it exists <br>
122   //! Set no one otherwise <br>
123   void Update(const TopoDS_Edge& theEdge);
124
125   //! If the face is not correctly triangulated, or if one <br>
126   //! of its edges is to be discretisated correctly, the <br>
127   //! triangulation of this face is built. <br>
128   void Update(const TopoDS_Face& theFace);
129 };
130
131 DEFINE_STANDARD_HANDLE(BRepMesh_IncrementalMesh,BRepMesh_DiscretRoot)
132
133 // other Inline functions and methods (like "C++: function call" methods)
134
135 #endif