include/opencascade/Extrema_FuncExtCS.hxx

0001 // Created on: 1996-01-22
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1996-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 _Extrema_FuncExtCS_HeaderFile
0018 #define _Extrema_FuncExtCS_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Pnt.hxx>
0024 #include <NCollection_Sequence.hxx>
0025 #include <Extrema_POnCurv.hxx>
0026 #include <Extrema_POnSurf.hxx>
0027 #include <math_FunctionSetWithDerivatives.hxx>
0028 #include <math_Vector.hxx>
0029 class Adaptor3d_Curve;
0030 class Adaptor3d_Surface;
0031 class math_Matrix;
0032 class Extrema_POnCurv;
0033 class Extrema_POnSurf;
0034
0035 //! Function to find extrema of the
0036 //! distance between a curve and a surface.
0037 class Extrema_FuncExtCS : public math_FunctionSetWithDerivatives
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   Standard_EXPORT Extrema_FuncExtCS();
0043
0044   Standard_EXPORT Extrema_FuncExtCS(const Adaptor3d_Curve& C, const Adaptor3d_Surface& S);
0045
0046   //! sets the field mysurf of the function.
0047   Standard_EXPORT void Initialize(const Adaptor3d_Curve& C, const Adaptor3d_Surface& S);
0048
0049   Standard_EXPORT int NbVariables() const override;
0050
0051   Standard_EXPORT int NbEquations() const override;
0052
0053   //! Calculation of Fi(U,V).
0054   Standard_EXPORT bool Value(const math_Vector& UV, math_Vector& F) override;
0055
0056   //! Calculation of Fi'(U,V).
0057   Standard_EXPORT bool Derivatives(const math_Vector& UV, math_Matrix& DF) override;
0058
0059   //! Calculation of Fi(U,V) and Fi'(U,V).
0060   Standard_EXPORT bool Values(const math_Vector& UV, math_Vector& F, math_Matrix& DF) override;
0061
0062   //! Save the found extremum.
0063   Standard_EXPORT int GetStateNumber() override;
0064
0065   //! Return the number of found extrema.
0066   Standard_EXPORT int NbExt() const;
0067
0068   //! Return the value of the Nth distance.
0069   Standard_EXPORT double SquareDistance(const int N) const;
0070
0071   //! Returns the Nth extremum on C.
0072   Standard_EXPORT const Extrema_POnCurv& PointOnCurve(const int N) const;
0073
0074   //! Return the Nth extremum on S.
0075   Standard_EXPORT const Extrema_POnSurf& PointOnSurface(const int N) const;
0076
0077   //! Change Sequence of SquareDistance
0078   NCollection_Sequence<double>& SquareDistances() { return mySqDist; }
0079
0080   //! Change Sequence of PointOnCurv
0081   NCollection_Sequence<Extrema_POnCurv>& PointsOnCurve() { return myPoint1; }
0082
0083   //! Change Sequence of PointOnSurf
0084   NCollection_Sequence<Extrema_POnSurf>& PointsOnSurf() { return myPoint2; }
0085
0086 private:
0087   const Adaptor3d_Curve*                myC;
0088   const Adaptor3d_Surface*              myS;
0089   gp_Pnt                                myP1;
0090   gp_Pnt                                myP2;
0091   double                                myt;
0092   double                                myU;
0093   double                                myV;
0094   NCollection_Sequence<double>          mySqDist;
0095   NCollection_Sequence<Extrema_POnCurv> myPoint1;
0096   NCollection_Sequence<Extrema_POnSurf> myPoint2;
0097   bool                                  myCinit;
0098   bool                                  mySinit;
0099 };
0100
0101 #endif // _Extrema_FuncExtCS_HeaderFile