0030435: Improving performance of Approx_ComputeCLine
[occt.git] / src / Approx / Approx_FitAndDivide2d.hxx
1 // Created on: 1993-01-26
2 // Created by: Laurent PAINNOT
3 // Copyright (c) 1993-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 _Approx_FitAndDivide2d_HeaderFile
18 #define _Approx_FitAndDivide2d_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <AppParCurves_SequenceOfMultiCurve.hxx>
25 #include <TColStd_SequenceOfReal.hxx>
26 #include <AppParCurves_MultiCurve.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <Standard_Integer.hxx>
29 #include <Standard_Real.hxx>
30 #include <AppParCurves_Constraint.hxx>
31 #include <AppCont_Function.hxx>
32 class AppParCurves_MultiCurve;
33
34
35
36 class Approx_FitAndDivide2d 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   
43   //! The MultiLine <Line> will be approximated until tolerances
44   //! will be reached.
45   //! The approximation will be done from degreemin to degreemax
46   //! with a cutting if the corresponding boolean is True.
47   Standard_EXPORT Approx_FitAndDivide2d(const AppCont_Function& Line, const Standard_Integer degreemin = 3, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-5, const Standard_Real Tolerance2d = 1.0e-5, const Standard_Boolean cutting = Standard_False, const AppParCurves_Constraint FirstC = AppParCurves_TangencyPoint, const AppParCurves_Constraint LastC = AppParCurves_TangencyPoint);
48   
49   //! Initializes the fields of the algorithm.
50   Standard_EXPORT Approx_FitAndDivide2d(const Standard_Integer degreemin = 3, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-05, const Standard_Real Tolerance2d = 1.0e-05, const Standard_Boolean cutting = Standard_False, const AppParCurves_Constraint FirstC = AppParCurves_TangencyPoint, const AppParCurves_Constraint LastC = AppParCurves_TangencyPoint);
51   
52   //! runs the algorithm after having initialized the fields.
53   Standard_EXPORT void Perform (const AppCont_Function& Line);
54   
55   //! changes the degrees of the approximation.
56   Standard_EXPORT void SetDegrees (const Standard_Integer degreemin, const Standard_Integer degreemax);
57   
58   //! Changes the tolerances of the approximation.
59   Standard_EXPORT void SetTolerances (const Standard_Real Tolerance3d, const Standard_Real Tolerance2d);
60   
61   //! Changes the constraints of the approximation.
62   Standard_EXPORT void SetConstraints (const AppParCurves_Constraint FirstC, const AppParCurves_Constraint LastC);
63
64   //! Changes the max number of segments, which is allowed for cutting.
65   Standard_EXPORT void SetMaxSegments (const Standard_Integer theMaxSegments);
66   
67   //! Set inverse order of degree selection:
68   //! if theInvOrdr = true, current degree is chosen by inverse order -
69   //! from maxdegree to mindegree.
70   //! By default inverse order is used.
71   Standard_EXPORT void SetInvOrder(const Standard_Boolean theInvOrder);
72
73   //! returns False if at a moment of the approximation,
74   //! the status NoApproximation has been sent by the user
75   //! when more points were needed.
76   Standard_EXPORT Standard_Boolean IsAllApproximated() const;
77   
78   //! returns False if the status NoPointsAdded has been sent.
79   Standard_EXPORT Standard_Boolean IsToleranceReached() const;
80   
81   //! returns the tolerances 2d and 3d of the <Index> MultiCurve.
82   Standard_EXPORT void Error (const Standard_Integer Index, Standard_Real& tol3d, Standard_Real& tol2d) const;
83   
84   //! Returns the number of MultiCurve doing the approximation
85   //! of the MultiLine.
86   Standard_EXPORT Standard_Integer NbMultiCurves() const;
87   
88   //! returns the approximation MultiCurve of range <Index>.
89   Standard_EXPORT AppParCurves_MultiCurve Value (const Standard_Integer Index = 1) const;
90   
91   Standard_EXPORT void Parameters (const Standard_Integer Index, Standard_Real& firstp, Standard_Real& lastp) const;
92
93
94
95
96 protected:
97
98
99
100
101
102 private:
103
104   
105   //! is internally used by the algorithms.
106   Standard_EXPORT Standard_Boolean Compute (const AppCont_Function& Line, const Standard_Real Ufirst, const Standard_Real Ulast, Standard_Real& TheTol3d, Standard_Real& TheTol2d);
107
108
109   AppParCurves_SequenceOfMultiCurve myMultiCurves;
110   TColStd_SequenceOfReal myfirstparam;
111   TColStd_SequenceOfReal mylastparam;
112   AppParCurves_MultiCurve TheMultiCurve;
113   Standard_Boolean alldone;
114   Standard_Boolean tolreached;
115   TColStd_SequenceOfReal Tolers3d;
116   TColStd_SequenceOfReal Tolers2d;
117   Standard_Integer mydegremin;
118   Standard_Integer mydegremax;
119   Standard_Real mytol3d;
120   Standard_Real mytol2d;
121   Standard_Real currenttol3d;
122   Standard_Real currenttol2d;
123   Standard_Boolean mycut;
124   AppParCurves_Constraint myfirstC;
125   AppParCurves_Constraint mylastC;
126   Standard_Integer myMaxSegments;
127   Standard_Boolean myInvOrder;
128
129 };
130
131
132
133
134
135
136
137 #endif // _Approx_FitAndDivide2d_HeaderFile