include/opencascade/ChFi3d_SearchSing.hxx

0001 // Created on: 1997-03-28
0002 // Created by: Philippe MANGIN
0003 // Copyright (c) 1997-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 _ChFi3d_SearchSing_HeaderFile
0018 #define _ChFi3d_SearchSing_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <math_FunctionWithDerivative.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <Standard_Real.hxx>
0027 class Geom_Curve;
0028
0029 //! Searches   singularities on fillet.
0030 //! F(t) = (C1(t) - C2(t)).(C1'(t) - C2'(t));
0031 class ChFi3d_SearchSing : public math_FunctionWithDerivative
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   Standard_EXPORT ChFi3d_SearchSing(const Handle(Geom_Curve)& C1, const Handle(Geom_Curve)& C2);
0037
0038   //! computes the value of the function <F> for the
0039   //! variable <X>.
0040   //! returns True if the computation was done successfully,
0041   //! False otherwise.
0042   Standard_EXPORT Standard_Boolean Value(const Standard_Real X, Standard_Real& F);
0043
0044   //! computes the derivative <D> of the function
0045   //! for the variable <X>.
0046   //! Returns True if the calculation were successfully done,
0047   //! False otherwise.
0048   Standard_EXPORT Standard_Boolean Derivative(const Standard_Real X, Standard_Real& D);
0049
0050   //! computes the value <F> and the derivative <D> of the
0051   //! function for the variable <X>.
0052   //! Returns True if the calculation were successfully done,
0053   //! False otherwise.
0054   Standard_EXPORT Standard_Boolean Values(const Standard_Real X,
0055                                           Standard_Real&      F,
0056                                           Standard_Real&      D);
0057
0058 protected:
0059 private:
0060   Handle(Geom_Curve) myC1;
0061   Handle(Geom_Curve) myC2;
0062 };
0063
0064 #endif // _ChFi3d_SearchSing_HeaderFile