0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / IntCurve / IntCurve_ProjectOnPConicTool.hxx
diff --git a/src/IntCurve/IntCurve_ProjectOnPConicTool.hxx b/src/IntCurve/IntCurve_ProjectOnPConicTool.hxx
new file mode 100644 (file)
index 0000000..a6c79a7
--- /dev/null
@@ -0,0 +1,87 @@
+// Created on: 1992-10-13
+// Created by: Laurent BUCHARD
+// Copyright (c) 1992-1999 Matra Datavision
+// Copyright (c) 1999-2014 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _IntCurve_ProjectOnPConicTool_HeaderFile
+#define _IntCurve_ProjectOnPConicTool_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_DefineAlloc.hxx>
+#include <Standard_Handle.hxx>
+
+#include <Standard_Real.hxx>
+class IntCurve_PConic;
+class gp_Pnt2d;
+
+
+//! This class provides a tool which computes the parameter
+//! of a point near a parametric conic.
+class IntCurve_ProjectOnPConicTool 
+{
+public:
+
+  DEFINE_STANDARD_ALLOC
+
+  
+  //! Returns  the parameter V  of the  point   on the
+  //! parametric  curve corresponding to  the  Point  Pnt.   The
+  //! Correspondance between  Pnt  and the  point   P(V) on  the
+  //! parametric    curve  must  be  coherent with    the way of
+  //! determination  of the signed  distance between a point and
+  //! the implicit curve.  Tol is the tolerance on  the distance
+  //! between a point and the parametrised curve.  In that case,
+  //! no bounds are given.  The research  of the rigth parameter
+  //! has to  be  made  on the natural  parametric domain of the
+  //! curve.
+  Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real Tol);
+  
+  //! Returns the  parameter  V of the   point  on the
+  //! parametric  curve corresponding  to  the   Point Pnt.  The
+  //! Correspondance  between Pnt and  the   point  P(V) on  the
+  //! parametric  curve  must  be  coherent   with the  way   of
+  //! determination of the  signed distance between  a point and
+  //! the implicit curve.  Tol  is the tolerance on the distance
+  //! between a point and the  parametrised curve.  LowParameter
+  //! and HighParameter give the  boundaries of the interval  in
+  //! wich the parameter  certainly  lies.  These parameters are
+  //! given to implement a  more efficient  algoritm. So,  it is
+  //! not necessary to check   that the returned value  verifies
+  //! LowParameter <= Value <= HighParameter.
+  Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real LowParameter, const Standard_Real HighParameter, const Standard_Real Tol);
+
+
+
+
+protected:
+
+
+
+
+
+private:
+
+
+
+
+
+};
+
+
+
+
+
+
+
+#endif // _IntCurve_ProjectOnPConicTool_HeaderFile