include/opencascade/Geom2dGcc_FunctionTanCirCu.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_FunctionTanCirCu_HeaderFile
0018 #define _Geom2dGcc_FunctionTanCirCu_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Circ2d.hxx>
0025 #include <Geom2dAdaptor_Curve.hxx>
0026 #include <math_FunctionWithDerivative.hxx>
0027
0028 //! This abstract class describes a Function of 1 Variable
0029 //! used to find a line tangent to a curve and a circle.
0030 class Geom2dGcc_FunctionTanCirCu : public math_FunctionWithDerivative
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   Standard_EXPORT Geom2dGcc_FunctionTanCirCu(const gp_Circ2d&           Circ,
0036                                              const Geom2dAdaptor_Curve& Curv);
0037
0038   //! Computes the value of the function F for the variable X.
0039   //! It returns True if the computation is successfully done,
0040   //! False otherwise.
0041   Standard_EXPORT bool Value(const double X, double& F) override;
0042
0043   //! Computes the derivative of the function F for the variable X.
0044   //! It returns True if the computation is successfully done,
0045   //! False otherwise.
0046   Standard_EXPORT bool Derivative(const double X, double& Deriv) override;
0047
0048   //! Computes the value and the derivative of the function F
0049   //! for the variable X.
0050   //! It returns True if the computation is successfully done,
0051   //! False otherwise.
0052   Standard_EXPORT bool Values(const double X, double& F, double& Deriv) override;
0053
0054 private:
0055   gp_Circ2d           TheCirc;
0056   Geom2dAdaptor_Curve Curve;
0057   double              myWeight;
0058 };
0059
0060 #endif // _Geom2dGcc_FunctionTanCirCu_HeaderFile