src/AppDef/AppDef_Compute.hxx

   1 // Created on: 1991-12-02
   2 // Created by: Laurent PAINNOT
   3 // Copyright (c) 1991-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 _AppDef_Compute_HeaderFile
  18 #define _AppDef_Compute_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 AppDef_MultiLine;
  39 class AppDef_MyLineTool;
  40 class AppDef_MyGradientOfCompute;
  41 class AppDef_ParLeastSquareOfMyGradientOfCompute;
  42 class AppDef_ResConstraintOfMyGradientOfCompute;
  43 class AppDef_ParFunctionOfMyGradientOfCompute;
  44 class AppDef_Gradient_BFGSOfMyGradientOfCompute;
  45 class AppParCurves_MultiCurve;
  46 class AppParCurves_MultiBSpCurve;
  47
  48
  49
  50 class AppDef_Compute
  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 AppDef_Compute(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);
  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 AppDef_Compute(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);
  72
  73   //! Initializes the fields of the algorithm.
  74   Standard_EXPORT AppDef_Compute(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 AppDef_Compute(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 AppDef_MultiLine& 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
 126
 127 protected:
 128
 129
 130
 131
 132
 133 private:
 134
 135
 136   //! is internally used in the algorithm.
 137   Standard_EXPORT Standard_Boolean Compute (const AppDef_MultiLine& Line,
 138                                             const Standard_Integer fpt,
 139                                             const Standard_Integer lpt,
 140                                             math_Vector& Para,
 141                                             Standard_Real& TheTol3d,
 142                                             Standard_Real& TheTol2d,
 143                                             Standard_Integer& indbad);
 144
 145   //! is internally used in the algorithm.
 146   Standard_EXPORT Standard_Boolean ComputeCurve (const AppDef_MultiLine& Line, const Standard_Integer firspt, const Standard_Integer lastpt);
 147
 148   //! computes new parameters between firstP and lastP.
 149   Standard_EXPORT void Parameters (const AppDef_MultiLine& Line, const Standard_Integer firstP, const Standard_Integer LastP, math_Vector& TheParameters) const;
 150
 151   Standard_EXPORT Standard_Real SearchFirstLambda (const AppDef_MultiLine& Line, const math_Vector& Para, const math_Vector& V, const Standard_Integer index) const;
 152
 153   Standard_EXPORT Standard_Real SearchLastLambda (const AppDef_MultiLine& Line, const math_Vector& Para, const math_Vector& V, const Standard_Integer index) const;
 154
 155   Standard_EXPORT void FirstTangencyVector (const AppDef_MultiLine& Line, const Standard_Integer index, math_Vector& V) const;
 156
 157   Standard_EXPORT void LastTangencyVector (const AppDef_MultiLine& Line, const Standard_Integer index, math_Vector& V) const;
 158
 159
 160   AppParCurves_SequenceOfMultiCurve myMultiCurves;
 161   AppParCurves_MultiCurve TheMultiCurve;
 162   AppParCurves_MultiBSpCurve myspline;
 163   Standard_Boolean alldone;
 164   Standard_Boolean tolreached;
 165   Approx_ParametrizationType Par;
 166   Handle(TColStd_HArray1OfReal) myParameters;
 167   Handle(TColStd_HArray1OfReal) myfirstParam;
 168   Approx_SequenceOfHArray1OfReal myPar;
 169   TColStd_SequenceOfReal Tolers3d;
 170   TColStd_SequenceOfReal Tolers2d;
 171   Handle(AppParCurves_HArray1OfConstraintCouple) myConstraints;
 172   Standard_Integer mydegremin;
 173   Standard_Integer mydegremax;
 174   Standard_Real mytol3d;
 175   Standard_Real mytol2d;
 176   Standard_Real currenttol3d;
 177   Standard_Real currenttol2d;
 178   Standard_Boolean mycut;
 179   Standard_Boolean mysquares;
 180   Standard_Integer myitermax;
 181   AppParCurves_Constraint myfirstC;
 182   AppParCurves_Constraint mylastC;
 183   Standard_Integer myMultiLineNb;
 184   Standard_Boolean myIsClear;
 185
 186
 187 };
 188
 189
 190
 191
 192
 193
 194
 195 #endif // _AppDef_Compute_HeaderFile