include/opencascade/IntImpParGen_ImpTool.hxx

0001 // Created on: 1992-03-26
0002 // Created by: Laurent BUCHARD
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 _IntImpParGen_ImpTool_HeaderFile
0018 #define _IntImpParGen_ImpTool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 class gp_Pnt2d;
0026 class gp_Vec2d;
0027
0028 //! Template class for an implicit curve.
0029 class IntImpParGen_ImpTool
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   Standard_EXPORT gp_Pnt2d Value(const double U) const;
0035
0036   Standard_EXPORT void D1(const double U, gp_Pnt2d& P, gp_Vec2d& T) const;
0037
0038   Standard_EXPORT void D2(const double U, gp_Pnt2d& P, gp_Vec2d& T, gp_Vec2d& N) const;
0039
0040   //! Computes the value of the signed distance between
0041   //! the point P and the implicit curve.
0042   Standard_EXPORT double Distance(const gp_Pnt2d& P) const;
0043
0044   //! Computes the Gradient of the Signed Distance
0045   //! between a point and the implicit curve, at the
0046   //! point P.
0047   Standard_EXPORT gp_Vec2d GradDistance(const gp_Pnt2d& P) const;
0048
0049   //! Returns the parameter U of the point on the
0050   //! implicit curve corresponding to the point P.
0051   //! The correspondence between P and the point P(U) on
0052   //! the implicit curve must be coherent with the way
0053   //! of determination of the signed distance.
0054   Standard_EXPORT double FindParameter(const gp_Pnt2d& P) const;
0055 };
0056
0057 #endif // _IntImpParGen_ImpTool_HeaderFile