include/opencascade/Geom2dGcc_FunctionTanCuCu.hxx

0001 // Created on: 1992-02-20
0002 // Created by: Remy GILET
0003 // Copyright (c) 1992-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 _Geom2dGcc_FunctionTanCuCu_HeaderFile
0018 #define _Geom2dGcc_FunctionTanCuCu_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Geom2dAdaptor_Curve.hxx>
0024 #include <gp_Circ2d.hxx>
0025 #include <Geom2dGcc_Type3.hxx>
0026 #include <math_FunctionSetWithDerivatives.hxx>
0027 #include <math_Vector.hxx>
0028 class gp_Pnt2d;
0029 class gp_Vec2d;
0030 class math_Matrix;
0031
0032 //! This abstract class describes a Function of 1 Variable
0033 //! used to find a line tangent to two curves.
0034 class Geom2dGcc_FunctionTanCuCu : public math_FunctionSetWithDerivatives
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   Standard_EXPORT Geom2dGcc_FunctionTanCuCu(const Geom2dAdaptor_Curve& Curv1,
0040                                             const Geom2dAdaptor_Curve& Curv2);
0041
0042   Standard_EXPORT Geom2dGcc_FunctionTanCuCu(const gp_Circ2d&           Circ1,
0043                                             const Geom2dAdaptor_Curve& Curv2);
0044
0045   Standard_EXPORT void InitDerivative(const math_Vector& X,
0046                                       gp_Pnt2d&          Point1,
0047                                       gp_Pnt2d&          Point2,
0048                                       gp_Vec2d&          Tan1,
0049                                       gp_Vec2d&          Tan2,
0050                                       gp_Vec2d&          D21,
0051                                       gp_Vec2d&          D22);
0052
0053   //! returns the number of variables of the function.
0054   Standard_EXPORT int NbVariables() const override;
0055
0056   //! returns the number of equations of the function.
0057   Standard_EXPORT int NbEquations() const override;
0058
0059   //! Computes the value of the function F for the variable X.
0060   //! It returns True if the computation is successfully done,
0061   //! False otherwise.
0062   Standard_EXPORT bool Value(const math_Vector& X, math_Vector& F) override;
0063
0064   //! Computes the derivative of the function F for the variable X.
0065   //! It returns True if the computation is successfully done,
0066   //! False otherwise.
0067   Standard_EXPORT bool Derivatives(const math_Vector& X, math_Matrix& Deriv) override;
0068
0069   //! Computes the value and the derivative of the function F
0070   //! for the variable X.
0071   //! It returns True if the computation is successfully done,
0072   //! False otherwise.
0073   Standard_EXPORT bool Values(const math_Vector& X, math_Vector& F, math_Matrix& Deriv) override;
0074
0075 private:
0076   Geom2dAdaptor_Curve TheCurve1;
0077   Geom2dAdaptor_Curve TheCurve2;
0078   gp_Circ2d           TheCirc1;
0079   Geom2dGcc_Type3     TheType;
0080 };
0081
0082 #endif // _Geom2dGcc_FunctionTanCuCu_HeaderFile