include/opencascade/AppDef_BSplineCompute.hxx

0001 // Created on: 1991-12-02
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1991-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _AppDef_BSplineCompute_HeaderFile
0018 #define _AppDef_BSplineCompute_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <AppParCurves_MultiBSpCurve.hxx>
0025 #include <Approx_ParametrizationType.hxx>
0026 #include <TColStd_HArray1OfReal.hxx>
0027 #include <TColStd_HArray1OfInteger.hxx>
0028 #include <AppParCurves_HArray1OfConstraintCouple.hxx>
0029 #include <Standard_Integer.hxx>
0030 #include <Standard_Real.hxx>
0031 #include <AppParCurves_Constraint.hxx>
0032 #include <math_Vector.hxx>
0033 #include <TColStd_Array1OfReal.hxx>
0034 #include <TColStd_Array1OfInteger.hxx>
0035 class AppDef_MultiLine;
0036 class AppDef_MyLineTool;
0037 class AppDef_MyBSplGradientOfBSplineCompute;
0038 class AppDef_BSpParLeastSquareOfMyBSplGradientOfBSplineCompute;
0039 class AppDef_BSpParFunctionOfMyBSplGradientOfBSplineCompute;
0040 class AppDef_BSpGradient_BFGSOfMyBSplGradientOfBSplineCompute;
0041 class AppDef_MyGradientbisOfBSplineCompute;
0042 class AppDef_ParLeastSquareOfMyGradientbisOfBSplineCompute;
0043 class AppDef_ResConstraintOfMyGradientbisOfBSplineCompute;
0044 class AppDef_ParFunctionOfMyGradientbisOfBSplineCompute;
0045 class AppDef_Gradient_BFGSOfMyGradientbisOfBSplineCompute;
0046 class AppParCurves_MultiBSpCurve;
0047 class AppParCurves_MultiCurve;
0048
0049
0050
0051 class AppDef_BSplineCompute
0052 {
0053 public:
0054
0055   DEFINE_STANDARD_ALLOC
0056
0057
0058   //! The MultiLine <Line> will be approximated until tolerances
0059   //! will be reached.
0060   //! The approximation will be done from degreemin to degreemax
0061   //! with a cutting if the corresponding boolean is True.
0062   //! If <Squares> is True, the computation will be done with
0063   //! no iteration at all.
0064   //!
0065   //! The multiplicities of the internal knots is set by
0066   //! default.
0067   Standard_EXPORT AppDef_BSplineCompute(const AppDef_MultiLine& 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);
0068
0069   //! The MultiLine <Line> will be approximated until tolerances
0070   //! will be reached.
0071   //! The approximation will be done from degreemin to degreemax
0072   //! with a cutting if the corresponding boolean is True.
0073   //! If <Squares> is True, the computation will be done with
0074   //! no iteration at all.
0075   Standard_EXPORT AppDef_BSplineCompute(const AppDef_MultiLine& 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);
0076
0077   //! Initializes the fields of the algorithm.
0078   Standard_EXPORT AppDef_BSplineCompute(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);
0079
0080   //! Initializes the fields of the algorithm.
0081   Standard_EXPORT AppDef_BSplineCompute(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);
0082
0083   //! Constructs an interpolation of the MultiLine <Line>
0084   //! The result will be a C2 curve of degree 3.
0085   Standard_EXPORT void Interpol (const AppDef_MultiLine& Line);
0086
0087   //! Initializes the fields of the algorithm.
0088   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);
0089
0090   //! runs the algorithm after having initialized the fields.
0091   Standard_EXPORT void Perform (const AppDef_MultiLine& Line);
0092
0093   //! The approximation will begin with the
0094   //! set of  parameters <ThePar>.
0095   Standard_EXPORT void SetParameters (const math_Vector& ThePar);
0096
0097   //! The approximation will be done with the
0098   //! set of knots <Knots>. The multiplicities will be set
0099   //! with the degree and the desired continuity.
0100   Standard_EXPORT void SetKnots (const TColStd_Array1OfReal& Knots);
0101
0102   //! The approximation will be done with the
0103   //! set of knots <Knots> and the multiplicities <Mults>.
0104   Standard_EXPORT void SetKnotsAndMultiplicities (const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults);
0105
0106   //! changes the degrees of the approximation.
0107   Standard_EXPORT void SetDegrees (const Standard_Integer degreemin, const Standard_Integer degreemax);
0108
0109   //! Changes the tolerances of the approximation.
0110   Standard_EXPORT void SetTolerances (const Standard_Real Tolerance3d, const Standard_Real Tolerance2d);
0111
0112   //! sets the continuity of the spline.
0113   //! if C = 2, the spline will be C2.
0114   Standard_EXPORT void SetContinuity (const Standard_Integer C);
0115
0116   //! changes the first and the last constraint points.
0117   Standard_EXPORT void SetConstraints (const AppParCurves_Constraint firstC, const AppParCurves_Constraint lastC);
0118
0119   //! Sets periodic flag.
0120   //! If thePeriodic = Standard_True, algorithm tries to build periodic
0121   //! multicurve using corresponding C1 boundary condition for first and last multipoints.
0122   //! Multiline must be closed.
0123   Standard_EXPORT void SetPeriodic(const Standard_Boolean thePeriodic);
0124
0125   //! returns False if at a moment of the approximation,
0126   //! the status NoApproximation has been sent by the user
0127   //! when more points were needed.
0128   Standard_EXPORT Standard_Boolean IsAllApproximated() const;
0129
0130   //! returns False if the status NoPointsAdded has been sent.
0131   Standard_EXPORT Standard_Boolean IsToleranceReached() const;
0132
0133   //! returns the tolerances 2d and 3d of the MultiBSpCurve.
0134   Standard_EXPORT void Error (Standard_Real& tol3d, Standard_Real& tol2d) const;
0135
0136   //! returns the result of the approximation.
0137   Standard_EXPORT const AppParCurves_MultiBSpCurve& Value() const;
0138
0139   //! returns the result of the approximation.
0140   Standard_EXPORT AppParCurves_MultiBSpCurve& ChangeValue();
0141
0142   //! returns the new parameters of the approximation
0143   //! corresponding to the points of the MultiBSpCurve.
0144   Standard_EXPORT const TColStd_Array1OfReal& Parameters() const;
0145
0146
0147
0148
0149 protected:
0150
0151
0152
0153
0154
0155 private:
0156
0157
0158   //! is internally used in the algorithm.
0159   Standard_EXPORT Standard_Boolean Compute (const AppDef_MultiLine& Line, const Standard_Integer fpt, const Standard_Integer lpt, math_Vector& Para, const TColStd_Array1OfReal& Knots, TColStd_Array1OfInteger& Mults);
0160
0161   //! is internally used in the algorithm.
0162   Standard_EXPORT Standard_Boolean ComputeCurve (const AppDef_MultiLine& Line, const Standard_Integer firspt, const Standard_Integer lastpt);
0163
0164   //! computes new parameters between firstP and lastP.
0165   Standard_EXPORT void Parameters (const AppDef_MultiLine& Line, const Standard_Integer firstP, const Standard_Integer LastP, math_Vector& TheParameters) const;
0166
0167   Standard_EXPORT Standard_Real SearchFirstLambda (const AppDef_MultiLine& Line, const math_Vector& Para, const TColStd_Array1OfReal& Knots, const math_Vector& V, const Standard_Integer index) const;
0168
0169   Standard_EXPORT Standard_Real SearchLastLambda (const AppDef_MultiLine& Line, const math_Vector& Para, const TColStd_Array1OfReal& Knots, const math_Vector& V, const Standard_Integer index) const;
0170
0171   Standard_EXPORT void TangencyVector (const AppDef_MultiLine& Line, const AppParCurves_MultiCurve& C, const Standard_Real U, math_Vector& V) const;
0172
0173   Standard_EXPORT void FirstTangencyVector (const AppDef_MultiLine& Line, const Standard_Integer index, math_Vector& V) const;
0174
0175   Standard_EXPORT void LastTangencyVector (const AppDef_MultiLine& Line, const Standard_Integer index, math_Vector& V) const;
0176
0177   Standard_EXPORT void FindRealConstraints (const AppDef_MultiLine& Line);
0178
0179
0180   AppParCurves_MultiBSpCurve TheMultiBSpCurve;
0181   Standard_Boolean alldone;
0182   Standard_Boolean tolreached;
0183   Approx_ParametrizationType Par;
0184   Handle(TColStd_HArray1OfReal) myParameters;
0185   Handle(TColStd_HArray1OfReal) myfirstParam;
0186   Handle(TColStd_HArray1OfReal) myknots;
0187   Handle(TColStd_HArray1OfInteger) mymults;
0188   Standard_Boolean myhasknots;
0189   Standard_Boolean myhasmults;
0190   Handle(AppParCurves_HArray1OfConstraintCouple) myConstraints;
0191   Standard_Integer mydegremin;
0192   Standard_Integer mydegremax;
0193   Standard_Real mytol3d;
0194   Standard_Real mytol2d;
0195   Standard_Real currenttol3d;
0196   Standard_Real currenttol2d;
0197   Standard_Boolean mycut;
0198   Standard_Boolean mysquares;
0199   Standard_Integer myitermax;
0200   AppParCurves_Constraint myfirstC;
0201   AppParCurves_Constraint mylastC;
0202   AppParCurves_Constraint realfirstC;
0203   AppParCurves_Constraint reallastC;
0204   Standard_Integer mycont;
0205   Standard_Real mylambda1;
0206   Standard_Real mylambda2;
0207   Standard_Boolean myPeriodic;
0208
0209
0210 };
0211
0212
0213
0214
0215
0216
0217
0218 #endif // _AppDef_BSplineCompute_HeaderFile