src/IntCurve/IntCurve_ProjectOnPConicTool.hxx

   1 // Created on: 1992-10-13
   2 // Created by: Laurent BUCHARD
   3 // Copyright (c) 1992-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IntCurve_ProjectOnPConicTool_HeaderFile
  18 #define _IntCurve_ProjectOnPConicTool_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22
  23 class IntCurve_PConic;
  24 class gp_Pnt2d;
  25
  26
  27 //! This class provides a tool which computes the parameter
  28 //! of a point near a parametric conic.
  29 class IntCurve_ProjectOnPConicTool
  30 {
  31 public:
  32
  33   DEFINE_STANDARD_ALLOC
  34
  35
  36   //! Returns  the parameter V  of the  point   on the
  37   //! parametric  curve corresponding to  the  Point  Pnt.   The
  38   //! Correspondence between  Pnt  and the  point   P(V) on  the
  39   //! parametric    curve  must  be  coherent with    the way of
  40   //! determination  of the signed  distance between a point and
  41   //! the implicit curve.  Tol is the tolerance on  the distance
  42   //! between a point and the parametrised curve.  In that case,
  43   //! no bounds are given.  The research  of the right parameter
  44   //! has to  be  made  on the natural  parametric domain of the
  45   //! curve.
  46   Standard_EXPORT static Standard_Real FindParameter (const IntCurve_PConic& C, const gp_Pnt2d& Pnt, const Standard_Real Tol);
  47
  48   //! Returns the  parameter  V of the   point  on the
  49   //! parametric  curve corresponding  to  the   Point Pnt.  The
  50   //! Correspondence  between Pnt and  the   point  P(V) on  the
  51   //! parametric  curve  must  be  coherent   with the  way   of
  52   //! determination of the  signed distance between  a point and
  53   //! the implicit curve.  Tol  is the tolerance on the distance
  54   //! between a point and the  parametrised curve.  LowParameter
  55   //! and HighParameter give the  boundaries of the interval  in
  56   //! which the parameter certainly  lies.  These parameters are
  57   //! given to implement a  more efficient  algorithm. So,  it is
  58   //! not necessary to check   that the returned value  verifies
  59   //! LowParameter <= Value <= HighParameter.
  60   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);
  61
  62
  63
  64
  65 protected:
  66
  67
  68
  69
  70
  71 private:
  72
  73
  74
  75
  76
  77 };
  78
  79
  80
  81
  82
  83
  84
  85 #endif // _IntCurve_ProjectOnPConicTool_HeaderFile