0026595: Lost some comments in OCCT-code after cdl elimination
[occt.git] / src / GeomInt / GeomInt_TheComputeLineOfWLApprox.hxx
index 5405386..b3a6e97 100644 (file)
@@ -56,44 +56,86 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! The MultiLine <Line> will be approximated until tolerances
+  //! will be reached.
+  //! The approximation will be done from degreemin to degreemax
+  //! with a cutting if the corresponding boolean is True.
+  //! If <Squares> is True, the computation will be done with
+  //! no iteration at all.
+  //!
+  //! The multiplicities of the internal knots is set by
+  //! default.
   Standard_EXPORT GeomInt_TheComputeLineOfWLApprox(const GeomInt_TheMultiLineOfWLApprox& 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);
   
+  //! The MultiLine <Line> will be approximated until tolerances
+  //! will be reached.
+  //! The approximation will be done from degreemin to degreemax
+  //! with a cutting if the corresponding boolean is True.
+  //! If <Squares> is True, the computation will be done with
+  //! no iteration at all.
   Standard_EXPORT GeomInt_TheComputeLineOfWLApprox(const GeomInt_TheMultiLineOfWLApprox& 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);
   
+  //! Initializes the fields of the algorithm.
   Standard_EXPORT GeomInt_TheComputeLineOfWLApprox(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);
   
+  //! Initializes the fields of the algorithm.
   Standard_EXPORT GeomInt_TheComputeLineOfWLApprox(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);
   
+  //! Constructs an interpolation of the MultiLine <Line>
+  //! The result will be a C2 curve of degree 3.
   Standard_EXPORT void Interpol (const GeomInt_TheMultiLineOfWLApprox& Line);
   
+  //! Initializes the fields of the algorithm.
   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);
   
+  //! runs the algorithm after having initialized the fields.
   Standard_EXPORT void Perform (const GeomInt_TheMultiLineOfWLApprox& Line);
   
+  //! The approximation will begin with the
+  //! set of  parameters <ThePar>.
   Standard_EXPORT void SetParameters (const math_Vector& ThePar);
   
+  //! The approximation will be done with the
+  //! set of knots <Knots>. The multiplicities will be set
+  //! with the degree and the desired continuity.
   Standard_EXPORT void SetKnots (const TColStd_Array1OfReal& Knots);
   
+  //! The approximation will be done with the
+  //! set of knots <Knots> and the multiplicities <Mults>.
   Standard_EXPORT void SetKnotsAndMultiplicities (const TColStd_Array1OfReal& Knots, const TColStd_Array1OfInteger& Mults);
   
+  //! changes the degrees of the approximation.
   Standard_EXPORT void SetDegrees (const Standard_Integer degreemin, const Standard_Integer degreemax);
   
+  //! Changes the tolerances of the approximation.
   Standard_EXPORT void SetTolerances (const Standard_Real Tolerance3d, const Standard_Real Tolerance2d);
   
+  //! sets the continuity of the spline.
+  //! if C = 2, the spline will be C2.
   Standard_EXPORT void SetContinuity (const Standard_Integer C);
   
+  //! changes the first and the last constraint points.
   Standard_EXPORT void SetConstraints (const AppParCurves_Constraint firstC, const AppParCurves_Constraint lastC);
   
+  //! returns False if at a moment of the approximation,
+  //! the status NoApproximation has been sent by the user
+  //! when more points were needed.
   Standard_EXPORT Standard_Boolean IsAllApproximated() const;
   
+  //! returns False if the status NoPointsAdded has been sent.
   Standard_EXPORT Standard_Boolean IsToleranceReached() const;
   
+  //! returns the tolerances 2d and 3d of the MultiBSpCurve.
   Standard_EXPORT void Error (Standard_Real& tol3d, Standard_Real& tol2d) const;
   
+  //! returns the result of the approximation.
   Standard_EXPORT const AppParCurves_MultiBSpCurve& Value() const;
   
+  //! returns the result of the approximation.
   Standard_EXPORT AppParCurves_MultiBSpCurve& ChangeValue();
   
+  //! returns the new parameters of the approximation
+  //! corresponding to the points of the MultiBSpCurve.
   Standard_EXPORT const TColStd_Array1OfReal& Parameters() const;
 
 
@@ -108,10 +150,13 @@ protected:
 private:
 
   
+  //! is internally used in the algorithm.
   Standard_EXPORT Standard_Boolean Compute (const GeomInt_TheMultiLineOfWLApprox& Line, const Standard_Integer fpt, const Standard_Integer lpt, math_Vector& Para, const TColStd_Array1OfReal& Knots, TColStd_Array1OfInteger& Mults);
   
+  //! is internally used in the algorithm.
   Standard_EXPORT Standard_Boolean ComputeCurve (const GeomInt_TheMultiLineOfWLApprox& Line, const Standard_Integer firspt, const Standard_Integer lastpt);
   
+  //! computes new parameters between firstP and lastP.
   Standard_EXPORT void Parameters (const GeomInt_TheMultiLineOfWLApprox& Line, const Standard_Integer firstP, const Standard_Integer LastP, math_Vector& TheParameters) const;
   
   Standard_EXPORT Standard_Real SearchFirstLambda (const GeomInt_TheMultiLineOfWLApprox& Line, const math_Vector& Para, const TColStd_Array1OfReal& Knots, const math_Vector& V, const Standard_Integer index) const;