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
0029 //! This abstract class describes a Function of 1 Variable
0030 //! used to find a line tangent to a curve and a circle.
0031 class Geom2dGcc_FunctionTanCirCu  : public math_FunctionWithDerivative
0032 {
0033 public:
0034
0035   DEFINE_STANDARD_ALLOC
0036
0037
0038   Standard_EXPORT Geom2dGcc_FunctionTanCirCu(const gp_Circ2d& Circ, const Geom2dAdaptor_Curve& Curv);
0039
0040   //! Computes the value of the function F for the variable X.
0041   //! It returns True if the computation is successfully done,
0042   //! False otherwise.
0043   Standard_EXPORT Standard_Boolean Value (const Standard_Real X, Standard_Real& F);
0044
0045   //! Computes the derivative of the function F for the variable X.
0046   //! It returns True if the computation is successfully done,
0047   //! False otherwise.
0048   Standard_EXPORT Standard_Boolean Derivative (const Standard_Real X, Standard_Real& Deriv);
0049
0050   //! Computes the value and the derivative of the function F
0051   //! for the variable X.
0052   //! It returns True if the computation is successfully done,
0053   //! False otherwise.
0054   Standard_EXPORT Standard_Boolean Values (const Standard_Real X, Standard_Real& F, Standard_Real& Deriv);
0055
0056
0057
0058
0059 protected:
0060
0061
0062
0063
0064
0065 private:
0066
0067
0068
0069   gp_Circ2d TheCirc;
0070   Geom2dAdaptor_Curve Curve;
0071   Standard_Real myWeight;
0072
0073
0074 };
0075
0076
0077
0078
0079
0080
0081
0082 #endif // _Geom2dGcc_FunctionTanCirCu_HeaderFile