include/opencascade/IntCurve_ProjectOnPConicTool.hxx

0001 // Created on: 1992-10-13
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 _IntCurve_ProjectOnPConicTool_HeaderFile
0018 #define _IntCurve_ProjectOnPConicTool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 class IntCurve_PConic;
0024 class gp_Pnt2d;
0025
0026
0027 //! This class provides a tool which computes the parameter
0028 //! of a point near a parametric conic.
0029 class IntCurve_ProjectOnPConicTool
0030 {
0031 public:
0032
0033   DEFINE_STANDARD_ALLOC
0034
0035
0036   //! Returns  the parameter V  of the  point   on the
0037   //! parametric  curve corresponding to  the  Point  Pnt.   The
0038   //! Correspondence between  Pnt  and the  point   P(V) on  the
0039   //! parametric    curve  must  be  coherent with    the way of
0040   //! determination  of the signed  distance between a point and
0041   //! the implicit curve.  Tol is the tolerance on  the distance
0042   //! between a point and the parametrised curve.  In that case,
0043   //! no bounds are given.  The research  of the right parameter
0044   //! has to  be  made  on the natural  parametric domain of the
0045   //! curve.
0046   Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real Tol);
0047
0048   //! Returns the  parameter  V of the   point  on the
0049   //! parametric  curve corresponding  to  the   Point Pnt.  The
0050   //! Correspondence  between Pnt and  the   point  P(V) on  the
0051   //! parametric  curve  must  be  coherent   with the  way   of
0052   //! determination of the  signed distance between  a point and
0053   //! the implicit curve.  Tol  is the tolerance on the distance
0054   //! between a point and the  parametrised curve.  LowParameter
0055   //! and HighParameter give the  boundaries of the interval  in
0056   //! which the parameter certainly  lies.  These parameters are
0057   //! given to implement a  more efficient  algorithm. So,  it is
0058   //! not necessary to check   that the returned value  verifies
0059   //! LowParameter <= Value <= HighParameter.
0060   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);
0061
0062
0063
0064
0065 protected:
0066
0067
0068
0069
0070
0071 private:
0072
0073
0074
0075
0076
0077 };
0078
0079
0080
0081
0082
0083
0084
0085 #endif // _IntCurve_ProjectOnPConicTool_HeaderFile