include/opencascade/Blend_CurvPointFuncInv.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_CurvPointFuncInv_HeaderFile
0018 #define _Blend_CurvPointFuncInv_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 //! The vector <X> used in Value, Values and Derivatives
0035 //! methods has to be the vector of the parametric
0036 //! coordinates w, U, V where w is the parameter on the
0037 //! guide line, U,V are the parametric coordinates of a
0038 //! point on the partner surface.
0039 class Blend_CurvPointFuncInv : public math_FunctionSetWithDerivatives
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Returns 3.
0045   Standard_EXPORT int NbVariables() const override;
0046
0047   //! returns the number of equations of the function.
0048   Standard_EXPORT int NbEquations() const override = 0;
0049
0050   //! computes the values <F> of the Functions for the
0051   //! variable <X>.
0052   //! Returns True if the computation was done successfully,
0053   //! False otherwise.
0054   Standard_EXPORT bool Value(const math_Vector& X, math_Vector& F) override = 0;
0055
0056   //! returns the values <D> of the derivatives for the
0057   //! variable <X>.
0058   //! Returns True if the computation was done successfully,
0059   //! False otherwise.
0060   Standard_EXPORT bool Derivatives(const math_Vector& X, math_Matrix& D) override = 0;
0061
0062   //! returns the values <F> of the functions and the derivatives
0063   //! <D> for the variable <X>.
0064   //! Returns True if the computation was done successfully,
0065   //! False otherwise.
0066   Standard_EXPORT bool Values(const math_Vector& X, math_Vector& F, math_Matrix& D) override = 0;
0067
0068   //! Set the Point on which a solution has to be found.
0069   Standard_EXPORT virtual void Set(const gp_Pnt& P) = 0;
0070
0071   //! Returns in the vector Tolerance the parametric tolerance
0072   //! for each of the 3 variables;
0073   //! Tol is the tolerance used in 3d space.
0074   Standard_EXPORT virtual void GetTolerance(math_Vector& Tolerance, const double Tol) const = 0;
0075
0076   //! Returns in the vector InfBound the lowest values allowed
0077   //! for each of the 3 variables.
0078   //! Returns in the vector SupBound the greatest values allowed
0079   //! for each of the 3 variables.
0080   Standard_EXPORT virtual void GetBounds(math_Vector& InfBound, math_Vector& SupBound) const = 0;
0081
0082   //! Returns true if Sol is a zero of the function.
0083   //! Tol is the tolerance used in 3d space.
0084   Standard_EXPORT virtual bool IsSolution(const math_Vector& Sol, const double Tol) = 0;
0085 };
0086
0087 #endif // _Blend_CurvPointFuncInv_HeaderFile