include/opencascade/Blend_FuncInv.hxx

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