0025748: Parallel version of progress indicator
[occt.git] / src / ShapeFix / ShapeFix_Shape.hxx
1 // Created on: 1998-08-12
2 // Created by: DATA EXCHANGE TEAM
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _ShapeFix_Shape_HeaderFile
18 #define _ShapeFix_Shape_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TopoDS_Shape.hxx>
24 #include <TopTools_MapOfShape.hxx>
25 #include <Standard_Integer.hxx>
26 #include <ShapeFix_Root.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <ShapeExtend_Status.hxx>
29 #include <Standard_Real.hxx>
30 #include <Message_ProgressRange.hxx>
31
32 class ShapeFix_Solid;
33 class ShapeFix_Shell;
34 class ShapeFix_Face;
35 class ShapeFix_Wire;
36 class ShapeFix_Edge;
37 class ShapeExtend_BasicMsgRegistrator;
38
39 // resolve name collisions with X11 headers
40 #ifdef Status
41   #undef Status
42 #endif
43
44 class ShapeFix_Shape;
45 DEFINE_STANDARD_HANDLE(ShapeFix_Shape, ShapeFix_Root)
46
47 //! Fixing shape in general
48 class ShapeFix_Shape : public ShapeFix_Root
49 {
50
51 public:
52
53   
54   //! Empty Constructor
55   Standard_EXPORT ShapeFix_Shape();
56   
57   //! Initislises by shape.
58   Standard_EXPORT ShapeFix_Shape(const TopoDS_Shape& shape);
59   
60   //! Initislises by shape.
61   Standard_EXPORT void Init (const TopoDS_Shape& shape);
62   
63   //! Iterates on sub- shape and performs fixes
64   Standard_EXPORT Standard_Boolean Perform (const Message_ProgressRange& theProgress = Message_ProgressRange());
65   
66   //! Returns resulting shape
67   Standard_EXPORT TopoDS_Shape Shape() const;
68   
69   //! Returns tool for fixing solids.
70     Handle(ShapeFix_Solid) FixSolidTool() const;
71   
72   //! Returns tool for fixing shells.
73     Handle(ShapeFix_Shell) FixShellTool() const;
74   
75   //! Returns tool for fixing faces.
76     Handle(ShapeFix_Face) FixFaceTool() const;
77   
78   //! Returns tool for fixing wires.
79     Handle(ShapeFix_Wire) FixWireTool() const;
80   
81   //! Returns tool for fixing edges.
82     Handle(ShapeFix_Edge) FixEdgeTool() const;
83   
84   //! Returns the status of the last Fix.
85   //! This can be a combination of the following flags:
86   //! ShapeExtend_DONE1: some free edges were fixed
87   //! ShapeExtend_DONE2: some free wires were fixed
88   //! ShapeExtend_DONE3: some free faces were fixed
89   //! ShapeExtend_DONE4: some free shells were fixed
90   //! ShapeExtend_DONE5: some free solids were fixed
91   //! ShapeExtend_DONE6: shapes in compound(s) were fixed
92   Standard_EXPORT Standard_Boolean Status (const ShapeExtend_Status status) const;
93   
94   //! Sets message registrator
95   Standard_EXPORT virtual void SetMsgRegistrator (const Handle(ShapeExtend_BasicMsgRegistrator)& msgreg) Standard_OVERRIDE;
96   
97   //! Sets basic precision value (also to FixSolidTool)
98   Standard_EXPORT virtual void SetPrecision (const Standard_Real preci) Standard_OVERRIDE;
99   
100   //! Sets minimal allowed tolerance (also to FixSolidTool)
101   Standard_EXPORT virtual void SetMinTolerance (const Standard_Real mintol) Standard_OVERRIDE;
102   
103   //! Sets maximal allowed tolerance (also to FixSolidTool)
104   Standard_EXPORT virtual void SetMaxTolerance (const Standard_Real maxtol) Standard_OVERRIDE;
105   
106   //! Returns (modifiable) the mode for applying fixes of
107   //! ShapeFix_Solid, by default True.
108     Standard_Integer& FixSolidMode();
109   
110   //! Returns (modifiable) the mode for applying fixes of
111   //! ShapeFix_Shell, by default True.
112     Standard_Integer& FixFreeShellMode();
113   
114   //! Returns (modifiable) the mode for applying fixes of
115   //! ShapeFix_Face, by default True.
116     Standard_Integer& FixFreeFaceMode();
117   
118   //! Returns (modifiable) the mode for applying fixes of
119   //! ShapeFix_Wire, by default True.
120     Standard_Integer& FixFreeWireMode();
121   
122   //! Returns (modifiable) the mode for applying
123   //! ShapeFix::SameParameter after all fixes, by default True.
124     Standard_Integer& FixSameParameterMode();
125   
126   //! Returns (modifiable) the mode for applying
127   //! ShapeFix::FixVertexPosition before all fixes, by default False.
128     Standard_Integer& FixVertexPositionMode();
129   
130   //! Returns (modifiable) the mode for fixing tolerances of vertices on whole shape
131   //! after performing all fixes
132     Standard_Integer& FixVertexTolMode();
133
134
135
136
137   DEFINE_STANDARD_RTTIEXT(ShapeFix_Shape,ShapeFix_Root)
138
139 protected:
140
141   
142   //! Fixes same parameterization problem on the passed shape
143   //! by updating tolerances of the corresponding topological
144   //! entitites.
145   Standard_EXPORT void SameParameter (const TopoDS_Shape& shape, const Standard_Boolean enforce,
146                                       const Message_ProgressRange& theProgress = Message_ProgressRange());
147
148   TopoDS_Shape myResult;
149   Handle(ShapeFix_Solid) myFixSolid;
150   TopTools_MapOfShape myMapFixingShape;
151   Standard_Integer myFixSolidMode;
152   Standard_Integer myFixShellMode;
153   Standard_Integer myFixFaceMode;
154   Standard_Integer myFixWireMode;
155   Standard_Integer myFixSameParameterMode;
156   Standard_Integer myFixVertexPositionMode;
157   Standard_Integer myFixVertexTolMode;
158   Standard_Integer myStatus;
159
160
161 private:
162
163
164
165
166 };
167
168
169 #include <ShapeFix_Shape.lxx>
170
171
172
173
174
175 #endif // _ShapeFix_Shape_HeaderFile