include/opencascade/Blend_SurfPointFuncInv.hxx

0001 // Created on: 1997-02-12
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1997-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 _Blend_SurfPointFuncInv_HeaderFile
0018 #define _Blend_SurfPointFuncInv_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <math_FunctionSetWithDerivatives.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <math_Vector.hxx>
0027 class math_Matrix;
0028 class gp_Pnt;
0029
0030 //! Deferred   class  for a  function  used  to compute  a
0031 //! blending surface between a  surface and a curve, using
0032 //! a  guide  line.   This   function is  used  to find  a
0033 //! solution on a done point of the curve.
0034 //!
0035 //! The vector <X>  used in Value, Values and  Derivatives
0036 //! methods  has  to   be the  vector   of the  parametric
0037 //! coordinates w, U,  V where w is  the parameter  on the
0038 //! guide line, U,V   are the parametric coordinates of  a
0039 //! point on the partner surface.
0040 class Blend_SurfPointFuncInv : public math_FunctionSetWithDerivatives
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Returns 3.
0046   Standard_EXPORT Standard_Integer NbVariables() const;
0047
0048   //! returns the number of equations of the function.
0049   Standard_EXPORT virtual Standard_Integer NbEquations() const = 0;
0050
0051   //! computes the values <F> of the Functions for the
0052   //! variable <X>.
0053   //! Returns True if the computation was done successfully,
0054   //! False otherwise.
0055   Standard_EXPORT virtual Standard_Boolean Value(const math_Vector& X, math_Vector& F) = 0;
0056
0057   //! returns the values <D> of the derivatives for the
0058   //! variable <X>.
0059   //! Returns True if the computation was done successfully,
0060   //! False otherwise.
0061   Standard_EXPORT virtual Standard_Boolean Derivatives(const math_Vector& X, math_Matrix& D) = 0;
0062
0063   //! returns the values <F> of the functions and the derivatives
0064   //! <D> for the variable <X>.
0065   //! Returns True if the computation was done successfully,
0066   //! False otherwise.
0067   Standard_EXPORT virtual Standard_Boolean Values(const math_Vector& X,
0068                                                   math_Vector&       F,
0069                                                   math_Matrix&       D) = 0;
0070
0071   //! Set the Point on which a solution has to be found.
0072   Standard_EXPORT virtual void Set(const gp_Pnt& P) = 0;
0073
0074   //! Returns in the vector Tolerance the parametric tolerance
0075   //! for each of the 3 variables;
0076   //! Tol is the tolerance used in 3d space.
0077   Standard_EXPORT virtual void GetTolerance(math_Vector&        Tolerance,
0078                                             const Standard_Real Tol) const = 0;
0079
0080   //! Returns in the vector InfBound the lowest values allowed
0081   //! for each of the 3 variables.
0082   //! Returns in the vector SupBound the greatest values allowed
0083   //! for each of the 3 variables.
0084   Standard_EXPORT virtual void GetBounds(math_Vector& InfBound, math_Vector& SupBound) const = 0;
0085
0086   //! Returns Standard_True if Sol is a zero of the function.
0087   //! Tol is the tolerance used in 3d space.
0088   Standard_EXPORT virtual Standard_Boolean IsSolution(const math_Vector&  Sol,
0089                                                       const Standard_Real Tol) = 0;
0090
0091 protected:
0092 private:
0093 };
0094
0095 #endif // _Blend_SurfPointFuncInv_HeaderFile