0026431: Can't cut a sphere from a cylinder
[occt.git] / src / BRepApprox / BRepApprox_TheComputeLineBezierOfApprox.hxx
1 // Created on: 1995-06-06
2 // Created by: Jean Yves LEBEY
3 // Copyright (c) 1995-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 _BRepApprox_TheComputeLineBezierOfApprox_HeaderFile
18 #define _BRepApprox_TheComputeLineBezierOfApprox_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <AppParCurves_SequenceOfMultiCurve.hxx>
25 #include <AppParCurves_MultiCurve.hxx>
26 #include <AppParCurves_MultiBSpCurve.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <Approx_ParametrizationType.hxx>
29 #include <TColStd_HArray1OfReal.hxx>
30 #include <Approx_SequenceOfHArray1OfReal.hxx>
31 #include <TColStd_SequenceOfReal.hxx>
32 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
33 #include <Standard_Integer.hxx>
34 #include <Standard_Real.hxx>
35 #include <AppParCurves_Constraint.hxx>
36 #include <math_Vector.hxx>
37 #include <TColStd_Array1OfReal.hxx>
38 class BRepApprox_TheMultiLineOfApprox;
39 class BRepApprox_TheMultiLineToolOfApprox;
40 class BRepApprox_MyGradientOfTheComputeLineBezierOfApprox;
41 class BRepApprox_ParLeastSquareOfMyGradientOfTheComputeLineBezierOfApprox;
42 class BRepApprox_ResConstraintOfMyGradientOfTheComputeLineBezierOfApprox;
43 class BRepApprox_ParFunctionOfMyGradientOfTheComputeLineBezierOfApprox;
44 class BRepApprox_Gradient_BFGSOfMyGradientOfTheComputeLineBezierOfApprox;
45 class AppParCurves_MultiCurve;
46 class AppParCurves_MultiBSpCurve;
47
48
49
50 class BRepApprox_TheComputeLineBezierOfApprox 
51 {
52 public:
53
54   DEFINE_STANDARD_ALLOC
55
56   
57   //! The MultiLine <Line> will be approximated until tolerances
58   //! will be reached.
59   //! The approximation will be done from degreemin to degreemax
60   //! with a cutting if the corresponding boolean is True.
61   //! If <Squares> is True, the computation will be done with
62   //! no iteration at all.
63   Standard_EXPORT BRepApprox_TheComputeLineBezierOfApprox(const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer degreemin = 4, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-3, const Standard_Real Tolerance2d = 1.0e-6, const Standard_Integer NbIterations = 5, const Standard_Boolean cutting = Standard_True, const Approx_ParametrizationType parametrization = Approx_ChordLength, const Standard_Boolean Squares = Standard_False);
64   
65   //! The MultiLine <Line> will be approximated until tolerances
66   //! will be reached.
67   //! The approximation will be done from degreemin to degreemax
68   //! with a cutting if the corresponding boolean is True.
69   //! If <Squares> is True, the computation will be done with
70   //! no iteration at all.
71   Standard_EXPORT BRepApprox_TheComputeLineBezierOfApprox(const BRepApprox_TheMultiLineOfApprox& Line, const math_Vector& Parameters, const Standard_Integer degreemin = 4, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-03, const Standard_Real Tolerance2d = 1.0e-06, const Standard_Integer NbIterations = 5, const Standard_Boolean cutting = Standard_True, const Standard_Boolean Squares = Standard_False);
72   
73   //! Initializes the fields of the algorithm.
74   Standard_EXPORT BRepApprox_TheComputeLineBezierOfApprox(const math_Vector& Parameters, const Standard_Integer degreemin = 4, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-03, const Standard_Real Tolerance2d = 1.0e-06, const Standard_Integer NbIterations = 5, const Standard_Boolean cutting = Standard_True, const Standard_Boolean Squares = Standard_False);
75   
76   //! Initializes the fields of the algorithm.
77   Standard_EXPORT BRepApprox_TheComputeLineBezierOfApprox(const Standard_Integer degreemin = 4, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-03, const Standard_Real Tolerance2d = 1.0e-06, const Standard_Integer NbIterations = 5, const Standard_Boolean cutting = Standard_True, const Approx_ParametrizationType parametrization = Approx_ChordLength, const Standard_Boolean Squares = Standard_False);
78   
79   //! Initializes the fields of the algorithm.
80   Standard_EXPORT void Init (const Standard_Integer degreemin = 4, const Standard_Integer degreemax = 8, const Standard_Real Tolerance3d = 1.0e-03, const Standard_Real Tolerance2d = 1.0e-06, const Standard_Integer NbIterations = 5, const Standard_Boolean cutting = Standard_True, const Approx_ParametrizationType parametrization = Approx_ChordLength, const Standard_Boolean Squares = Standard_False);
81   
82   //! runs the algorithm after having initialized the fields.
83   Standard_EXPORT void Perform (const BRepApprox_TheMultiLineOfApprox& Line);
84   
85   //! changes the degrees of the approximation.
86   Standard_EXPORT void SetDegrees (const Standard_Integer degreemin, const Standard_Integer degreemax);
87   
88   //! Changes the tolerances of the approximation.
89   Standard_EXPORT void SetTolerances (const Standard_Real Tolerance3d, const Standard_Real Tolerance2d);
90   
91   //! changes the first and the last constraint points.
92   Standard_EXPORT void SetConstraints (const AppParCurves_Constraint firstC, const AppParCurves_Constraint lastC);
93   
94   //! returns False if at a moment of the approximation,
95   //! the status NoApproximation has been sent by the user
96   //! when more points were needed.
97   Standard_EXPORT Standard_Boolean IsAllApproximated() const;
98   
99   //! returns False if the status NoPointsAdded has been sent.
100   Standard_EXPORT Standard_Boolean IsToleranceReached() const;
101   
102   //! returns the tolerances 2d and 3d of the <Index> MultiCurve.
103   Standard_EXPORT void Error (const Standard_Integer Index, Standard_Real& tol3d, Standard_Real& tol2d) const;
104   
105   //! Returns the number of MultiCurve doing the approximation
106   //! of the MultiLine.
107   Standard_EXPORT Standard_Integer NbMultiCurves() const;
108   
109   //! returns the result of the approximation.
110   Standard_EXPORT const AppParCurves_MultiCurve& Value (const Standard_Integer Index = 1) const;
111   
112   //! returns the result of the approximation.
113   Standard_EXPORT AppParCurves_MultiCurve& ChangeValue (const Standard_Integer Index = 1);
114   
115   //! returns the result of the approximation.
116   Standard_EXPORT const AppParCurves_MultiBSpCurve& SplineValue();
117   
118   //! returns the type  of  parametrization
119   Standard_EXPORT Approx_ParametrizationType Parametrization () const;
120   
121   //! returns the new parameters of the approximation
122   //! corresponding to the points of the multicurve <Index>.
123   Standard_EXPORT const TColStd_Array1OfReal& Parameters (const Standard_Integer Index = 1) const;
124
125 protected:
126
127
128
129
130
131 private:
132
133   
134   //! is internally used in the algorithm.
135   Standard_EXPORT Standard_Boolean Compute (const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer fpt, const Standard_Integer lpt, math_Vector& Para, Standard_Real& TheTol3d, Standard_Real& TheTol2d);
136   
137   //! is internally used in the algorithm.
138   Standard_EXPORT Standard_Boolean ComputeCurve (const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer firspt, const Standard_Integer lastpt);
139   
140   //! computes new parameters between firstP and lastP.
141   Standard_EXPORT void Parameters (const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer firstP, const Standard_Integer LastP, math_Vector& TheParameters) const;
142   
143   Standard_EXPORT Standard_Real SearchFirstLambda (const BRepApprox_TheMultiLineOfApprox& Line, const math_Vector& Para, const math_Vector& V, const Standard_Integer index) const;
144   
145   Standard_EXPORT Standard_Real SearchLastLambda (const BRepApprox_TheMultiLineOfApprox& Line, const math_Vector& Para, const math_Vector& V, const Standard_Integer index) const;
146   
147   Standard_EXPORT void FirstTangencyVector (const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer index, math_Vector& V) const;
148   
149   Standard_EXPORT void LastTangencyVector (const BRepApprox_TheMultiLineOfApprox& Line, const Standard_Integer index, math_Vector& V) const;
150
151
152   AppParCurves_SequenceOfMultiCurve myMultiCurves;
153   AppParCurves_MultiCurve TheMultiCurve;
154   AppParCurves_MultiBSpCurve myspline;
155   Standard_Boolean alldone;
156   Standard_Boolean tolreached;
157   Approx_ParametrizationType Par;
158   Handle(TColStd_HArray1OfReal) myParameters;
159   Handle(TColStd_HArray1OfReal) myfirstParam;
160   Approx_SequenceOfHArray1OfReal myPar;
161   TColStd_SequenceOfReal Tolers3d;
162   TColStd_SequenceOfReal Tolers2d;
163   Handle(AppParCurves_HArray1OfConstraintCouple) myConstraints;
164   Standard_Integer mydegremin;
165   Standard_Integer mydegremax;
166   Standard_Real mytol3d;
167   Standard_Real mytol2d;
168   Standard_Real currenttol3d;
169   Standard_Real currenttol2d;
170   Standard_Boolean mycut;
171   Standard_Boolean mysquares;
172   Standard_Integer myitermax;
173   AppParCurves_Constraint myfirstC;
174   AppParCurves_Constraint mylastC;
175   Standard_Integer myMultiLineNb;
176   Standard_Boolean myIsClear;
177
178
179 };
180
181
182
183
184
185
186
187 #endif // _BRepApprox_TheComputeLineBezierOfApprox_HeaderFile