src/Blend/Blend_FuncInv.hxx

   1 // Created on: 1993-12-02
   2 // Created by: Jacques GOUSSARD
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Blend_FuncInv_HeaderFile
  18 #define _Blend_FuncInv_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <math_FunctionSetWithDerivatives.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <math_Vector.hxx>
  28 #include <Standard_Real.hxx>
  29 class math_Matrix;
  30 class Adaptor2d_HCurve2d;
  31
  32
  33 //! Deferred class for a function used to compute a blending
  34 //! surface between two surfaces, using a guide line.
  35 //! This function is used to find a solution on a restriction
  36 //! of one of the surface.
  37 //! The vector <X> used in Value, Values and Derivatives methods
  38 //! has to be the vector of the parametric coordinates t,w,U,V
  39 //! where t is the parameter on the curve on surface,
  40 //! w is the parameter on the guide line,
  41 //! U,V are the parametric coordinates of a point on the
  42 //! partner surface.
  43 class Blend_FuncInv  : public math_FunctionSetWithDerivatives
  44 {
  45 public:
  46
  47   DEFINE_STANDARD_ALLOC
  48
  49
  50   //! Returns 4.
  51   Standard_EXPORT Standard_Integer NbVariables() const;
  52
  53   //! returns the number of equations of the function.
  54   Standard_EXPORT virtual Standard_Integer NbEquations() const = 0;
  55
  56   //! computes the values <F> of the Functions for the
  57   //! variable <X>.
  58   //! Returns True if the computation was done successfully,
  59   //! False otherwise.
  60   Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, math_Vector& F) = 0;
  61
  62   //! returns the values <D> of the derivatives for the
  63   //! variable <X>.
  64   //! Returns True if the computation was done successfully,
  65   //! False otherwise.
  66   Standard_EXPORT virtual Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D) = 0;
  67
  68   //! returns the values <F> of the functions and the derivatives
  69   //! <D> for the variable <X>.
  70   //! Returns True if the computation was done successfully,
  71   //! False otherwise.
  72   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D) = 0;
  73
  74   //! Sets the CurveOnSurface on which a solution has
  75   //! to be found. If <OnFirst> is set to Standard_True,
  76   //! the curve will be on the first surface, otherwise the
  77   //! curve is on the second one.
  78   Standard_EXPORT virtual void Set (const Standard_Boolean OnFirst, const Handle(Adaptor2d_HCurve2d)& COnSurf) = 0;
  79
  80   //! Returns in the vector Tolerance the parametric tolerance
  81   //! for each of the 4 variables;
  82   //! Tol is the tolerance used in 3d space.
  83   Standard_EXPORT virtual void GetTolerance (math_Vector& Tolerance, const Standard_Real Tol) const = 0;
  84
  85   //! Returns in the vector InfBound the lowest values allowed
  86   //! for each of the 4 variables.
  87   //! Returns in the vector SupBound the greatest values allowed
  88   //! for each of the 4 variables.
  89   Standard_EXPORT virtual void GetBounds (math_Vector& InfBound, math_Vector& SupBound) const = 0;
  90
  91   //! Returns Standard_True if Sol is a zero of the function.
  92   //! Tol is the tolerance used in 3d space.
  93   Standard_EXPORT virtual Standard_Boolean IsSolution (const math_Vector& Sol, const Standard_Real Tol) = 0;
  94
  95
  96
  97
  98 protected:
  99
 100
 101
 102
 103
 104 private:
 105
 106
 107
 108
 109
 110 };
 111
 112
 113
 114
 115
 116
 117
 118 #endif // _Blend_FuncInv_HeaderFile