0025748: Parallel version of progress indicator
[occt.git] / src / IGESToBRep / IGESToBRep_CurveAndSurface.hxx
1 // Created on: 1994-03-14
2 // Created by: s:       Christophe GUYOT & Frederic UNTEREINER
3 // Copyright (c) 1994-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 _IGESToBRep_CurveAndSurface_HeaderFile
18 #define _IGESToBRep_CurveAndSurface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Message_ProgressRange.hxx>
28
29 class Geom_Surface;
30 class IGESData_IGESModel;
31 class Transfer_TransientProcess;
32 class TopoDS_Shape;
33 class IGESData_IGESEntity;
34 class Message_Msg;
35
36 //! Provides methods to transfer CurveAndSurface from IGES to CASCADE.
37 class IGESToBRep_CurveAndSurface 
38 {
39 public:
40
41   DEFINE_STANDARD_ALLOC
42
43   
44   //! Creates  a tool CurveAndSurface  ready  to  run, with
45   //! epsilons  set  to  1.E-04,  myModeTopo  to  True,  the
46   //! optimization of  the continuity to False.
47   Standard_EXPORT IGESToBRep_CurveAndSurface();
48   
49   //! Creates a tool CurveAndSurface ready to run.
50   Standard_EXPORT IGESToBRep_CurveAndSurface(const Standard_Real eps, const Standard_Real epsGeom, const Standard_Real epsCoeff, const Standard_Boolean mode, const Standard_Boolean modeapprox, const Standard_Boolean optimized);
51   
52   //! Initializes the field of the tool CurveAndSurface with
53   //! default creating values.
54   Standard_EXPORT void Init();
55   
56   //! Changes the value of "myEps"
57     void SetEpsilon (const Standard_Real eps);
58   
59   //! Returns the value of "myEps"
60     Standard_Real GetEpsilon() const;
61   
62   //! Changes the value of "myEpsCoeff"
63     void SetEpsCoeff (const Standard_Real eps);
64   
65   //! Returns the value of "myEpsCoeff"
66     Standard_Real GetEpsCoeff() const;
67   
68   //! Changes the value of "myEpsGeom"
69   Standard_EXPORT void SetEpsGeom (const Standard_Real eps);
70   
71   //! Returns the value of "myEpsGeom"
72     Standard_Real GetEpsGeom() const;
73   
74   //! Changes the value of "myMinTol"
75     void SetMinTol (const Standard_Real mintol);
76   
77   //! Changes the value of "myMaxTol"
78     void SetMaxTol (const Standard_Real maxtol);
79   
80   //! Sets values of "myMinTol" and "myMaxTol" as follows
81   //! myMaxTol = Max ("read.maxprecision.val", myEpsGeom * myUnitFactor)
82   //! myMinTol = Precision::Confusion()
83   //! Remark:   This method is automatically invoked each time the values
84   //! of "myEpsGeom" or "myUnitFactor" are changed
85   Standard_EXPORT void UpdateMinMaxTol();
86   
87   //! Returns the value of "myMinTol"
88     Standard_Real GetMinTol() const;
89   
90   //! Returns the value of "myMaxTol"
91     Standard_Real GetMaxTol() const;
92   
93   //! Changes the value of "myModeApprox"
94     void SetModeApprox (const Standard_Boolean mode);
95   
96   //! Returns the value of "myModeApprox"
97     Standard_Boolean GetModeApprox() const;
98   
99   //! Changes the value of "myModeIsTopo"
100     void SetModeTransfer (const Standard_Boolean mode);
101   
102   //! Returns the value of "myModeIsTopo"
103     Standard_Boolean GetModeTransfer() const;
104   
105   //! Changes the value of "myContIsOpti"
106     void SetOptimized (const Standard_Boolean optimized);
107   
108   //! Returns the value of "myContIsOpti"
109     Standard_Boolean GetOptimized() const;
110   
111   //! Returns the value of " myUnitFactor"
112     Standard_Real GetUnitFactor() const;
113   
114   //! Changes the value of "mySurfaceCurve"
115     void SetSurfaceCurve (const Standard_Integer ival);
116   
117   //! Returns the value of  " mySurfaceCurve" 0 = value in
118   //! file , 2  = kepp 2d   and compute 3d   3 = keep 3d and
119   //! compute 2d
120     Standard_Integer GetSurfaceCurve() const;
121   
122   //! Set the value of "myModel"
123   Standard_EXPORT void SetModel (const Handle(IGESData_IGESModel)& model);
124   
125   //! Returns the value of "myModel"
126     Handle(IGESData_IGESModel) GetModel() const;
127   
128   //! Changes the value of "myContinuity"
129   //! if continuity = 0 do nothing else
130   //! if continuity = 1 try C1
131   //! if continuity = 2 try C2
132     void SetContinuity (const Standard_Integer continuity);
133   
134   //! Returns the value of "myContinuity"
135     Standard_Integer GetContinuity() const;
136   
137   //! Set the value of "myMsgReg"
138     void SetTransferProcess (const Handle(Transfer_TransientProcess)& TP);
139   
140   //! Returns the value of "myMsgReg"
141     Handle(Transfer_TransientProcess) GetTransferProcess() const;
142   
143   //! Returns the result of the transfert of any IGES Curve
144   //! or Surface Entity.  If  the transfer has  failed,  this
145   //! member return a NullEntity.
146   Standard_EXPORT TopoDS_Shape TransferCurveAndSurface (const Handle(IGESData_IGESEntity)& start,
147                                                         const Message_ProgressRange& theProgress = Message_ProgressRange());
148   
149   //! Returns the result of the transfert the geometry of
150   //! any IGESEntity.  If  the transfer has  failed,  this
151   //! member return a NullEntity.
152   Standard_EXPORT TopoDS_Shape TransferGeometry (const Handle(IGESData_IGESEntity)& start,
153                                                  const Message_ProgressRange& theProgress = Message_ProgressRange());
154   
155   //! Records a new Fail message
156     void SendFail (const Handle(IGESData_IGESEntity)& start, const Message_Msg& amsg);
157   
158   //! Records a new Warning message
159     void SendWarning (const Handle(IGESData_IGESEntity)& start, const Message_Msg& amsg);
160   
161   //! Records a new Information message from the definition
162   //! of a Msg (Original+Value)
163     void SendMsg (const Handle(IGESData_IGESEntity)& start, const Message_Msg& amsg);
164   
165   //! Returns True if start was already treated and has a result in "myMap"
166   //! else returns False.
167   Standard_EXPORT Standard_Boolean HasShapeResult (const Handle(IGESData_IGESEntity)& start) const;
168   
169   //! Returns the result of the transfer of the IGESEntity "start" contained
170   //! in "myMap" . (if HasShapeResult is True).
171   Standard_EXPORT TopoDS_Shape GetShapeResult (const Handle(IGESData_IGESEntity)& start) const;
172   
173   //! set in "myMap" the result of the transfer of the IGESEntity "start".
174   Standard_EXPORT void SetShapeResult (const Handle(IGESData_IGESEntity)& start, const TopoDS_Shape& result);
175   
176   //! Returns the number of shapes results contained in "myMap" for the
177   //! IGESEntity start ( type VertexList or EdgeList).
178   Standard_EXPORT Standard_Integer NbShapeResult (const Handle(IGESData_IGESEntity)& start) const;
179   
180   //! Returns the numth result of the IGESEntity start (type VertexList or
181   //! EdgeList) in "myMap". (if NbShapeResult is not null).
182   Standard_EXPORT TopoDS_Shape GetShapeResult (const Handle(IGESData_IGESEntity)& start, const Standard_Integer num) const;
183   
184   //! set in "myMap" the result of the transfer of the entity of the
185   //! IGESEntity start ( type VertexList or EdgeList).
186   Standard_EXPORT void AddShapeResult (const Handle(IGESData_IGESEntity)& start, const TopoDS_Shape& result);
187   
188   Standard_EXPORT void SetSurface (const Handle(Geom_Surface)& theSurface);
189   
190   Standard_EXPORT Handle(Geom_Surface) Surface() const;
191   
192   Standard_EXPORT Standard_Real GetUVResolution();
193
194
195
196
197 protected:
198
199
200
201
202
203 private:
204
205
206
207   Standard_Real myEps;
208   Standard_Real myEpsCoeff;
209   Standard_Real myEpsGeom;
210   Standard_Real myMinTol;
211   Standard_Real myMaxTol;
212   Standard_Boolean myModeIsTopo;
213   Standard_Boolean myModeApprox;
214   Standard_Boolean myContIsOpti;
215   Standard_Real myUnitFactor;
216   Standard_Integer mySurfaceCurve;
217   Standard_Integer myContinuity;
218   Handle(Geom_Surface) mySurface;
219   Standard_Real myUVResolution;
220   Standard_Boolean myIsResolCom;
221   Handle(IGESData_IGESModel) myModel;
222   Handle(Transfer_TransientProcess) myTP;
223
224
225 };
226
227
228 #include <IGESToBRep_CurveAndSurface.lxx>
229
230
231
232
233
234 #endif // _IGESToBRep_CurveAndSurface_HeaderFile