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 <TColStd_SequenceOfReal.hxx>
0025 #include <Extrema_SequenceOfPOnCurv.hxx>
0026 #include <Extrema_SequenceOfPOnSurf.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
0036 //! Function to find extrema of the
0037 //! distance between a curve and a surface.
0038 class Extrema_FuncExtCS  : public math_FunctionSetWithDerivatives
0039 {
0040 public:
0041
0042   DEFINE_STANDARD_ALLOC
0043
0044
0045   Standard_EXPORT Extrema_FuncExtCS();
0046
0047   Standard_EXPORT Extrema_FuncExtCS(const Adaptor3d_Curve& C, const Adaptor3d_Surface& S);
0048
0049   //! sets the field mysurf of the function.
0050   Standard_EXPORT void Initialize (const Adaptor3d_Curve& C, const Adaptor3d_Surface& S);
0051
0052   Standard_EXPORT Standard_Integer NbVariables() const Standard_OVERRIDE;
0053
0054   Standard_EXPORT Standard_Integer NbEquations() const Standard_OVERRIDE;
0055
0056   //! Calculation of Fi(U,V).
0057   Standard_EXPORT Standard_Boolean Value (const math_Vector& UV, math_Vector& F) Standard_OVERRIDE;
0058
0059   //! Calculation of Fi'(U,V).
0060   Standard_EXPORT Standard_Boolean Derivatives (const math_Vector& UV, math_Matrix& DF) Standard_OVERRIDE;
0061
0062   //! Calculation of Fi(U,V) and Fi'(U,V).
0063   Standard_EXPORT Standard_Boolean Values (const math_Vector& UV, math_Vector& F, math_Matrix& DF) Standard_OVERRIDE;
0064
0065   //! Save the found extremum.
0066   Standard_EXPORT virtual Standard_Integer GetStateNumber() Standard_OVERRIDE;
0067
0068   //! Return the number of found extrema.
0069   Standard_EXPORT Standard_Integer NbExt() const;
0070
0071   //! Return the value of the Nth distance.
0072   Standard_EXPORT Standard_Real SquareDistance (const Standard_Integer N) const;
0073
0074   //! Returns the Nth extremum on C.
0075   Standard_EXPORT const Extrema_POnCurv& PointOnCurve (const Standard_Integer N) const;
0076
0077   //! Return the Nth extremum on S.
0078   Standard_EXPORT const Extrema_POnSurf& PointOnSurface (const Standard_Integer N) const;
0079
0080   //! Change Sequence of SquareDistance
0081   TColStd_SequenceOfReal& SquareDistances()
0082   {
0083     return mySqDist;
0084   }
0085   //! Change Sequence of PointOnCurv
0086   Extrema_SequenceOfPOnCurv& PointsOnCurve()
0087   {
0088     return myPoint1;
0089   }
0090   //! Change Sequence of PointOnSurf
0091   Extrema_SequenceOfPOnSurf& PointsOnSurf()
0092   {
0093     return myPoint2;
0094   }
0095
0096 private:
0097
0098   const Adaptor3d_Curve* myC;
0099   const Adaptor3d_Surface* myS;
0100   gp_Pnt myP1;
0101   gp_Pnt myP2;
0102   Standard_Real myt;
0103   Standard_Real myU;
0104   Standard_Real myV;
0105   TColStd_SequenceOfReal mySqDist;
0106   Extrema_SequenceOfPOnCurv myPoint1;
0107   Extrema_SequenceOfPOnSurf myPoint2;
0108   Standard_Boolean myCinit;
0109   Standard_Boolean mySinit;
0110
0111 };
0112
0113 #endif // _Extrema_FuncExtCS_HeaderFile