src/Geom2dInt/Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter.hxx

   1 // Created on: 1992-06-04
   2 // Created by: Jacques GOUSSARD
   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 _Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter_HeaderFile
  18 #define _Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Real.hxx>
  26 #include <Geom2dInt_PCLocFOfTheLocateExtPCOfTheProjPCurOfGInter.hxx>
  27 class Standard_DomainError;
  28 class Standard_TypeMismatch;
  29 class StdFail_NotDone;
  30 class Adaptor2d_Curve2d;
  31 class Geom2dInt_Geom2dCurveTool;
  32 class Extrema_POnCurv2d;
  33 class gp_Pnt2d;
  34 class gp_Vec2d;
  35 class Geom2dInt_PCLocFOfTheLocateExtPCOfTheProjPCurOfGInter;
  36 class Geom2dInt_SeqPCOfPCLocFOfTheLocateExtPCOfTheProjPCurOfGInter;
  37
  38
  39
  40 class Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47   Standard_EXPORT Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter();
  48
  49   //! Calculates the distance with a close point.
  50   //! The close point is defined by the parameter value
  51   //! U0.
  52   //! The function F(u)=distance(P,C(u)) has an extremum
  53   //! when g(u)=dF/du=0. The algorithm searchs a zero
  54   //! near the close point.
  55   //! TolU is used to decide to stop the iterations.
  56   //! At the nth iteration, the criteria is:
  57   //! abs(Un - Un-1) < TolU.
  58   Standard_EXPORT Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter(const gp_Pnt2d& P, const Adaptor2d_Curve2d& C, const Standard_Real U0, const Standard_Real TolU);
  59
  60   //! Calculates the distance with a close point.
  61   //! The close point is defined by the parameter value
  62   //! U0.
  63   //! The function F(u)=distance(P,C(u)) has an extremum
  64   //! when g(u)=dF/du=0. The algorithm searchs a zero
  65   //! near the close point.
  66   //! Zeros are searched between Umin et Usup.
  67   //! TolU is used to decide to stop the iterations.
  68   //! At the nth iteration, the criteria is:
  69   //! abs(Un - Un-1) < TolU.
  70   Standard_EXPORT Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter(const gp_Pnt2d& P, const Adaptor2d_Curve2d& C, const Standard_Real U0, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
  71
  72   //! sets the fields of the algorithm.
  73   Standard_EXPORT void Initialize (const Adaptor2d_Curve2d& C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
  74
  75   //! the algorithm is done with the point P.
  76   //! An exception is raised if the fields have not
  77   //! been initialized.
  78   Standard_EXPORT void Perform (const gp_Pnt2d& P, const Standard_Real U0);
  79
  80   //! Returns True if the distance is found.
  81   Standard_EXPORT Standard_Boolean IsDone() const;
  82
  83   //! Returns the value of the extremum square distance.
  84   Standard_EXPORT Standard_Real SquareDistance() const;
  85
  86   //! Returns True if the extremum distance is a minimum.
  87   Standard_EXPORT Standard_Boolean IsMin() const;
  88
  89   //! Returns the point of the extremum distance.
  90   Standard_EXPORT const Extrema_POnCurv2d& Point() const;
  91
  92
  93
  94
  95 protected:
  96
  97
  98
  99
 100
 101 private:
 102
 103
 104
 105   Standard_Boolean myDone;
 106   Standard_Real mytolU;
 107   Standard_Real myumin;
 108   Standard_Real myusup;
 109   Geom2dInt_PCLocFOfTheLocateExtPCOfTheProjPCurOfGInter myF;
 110
 111
 112 };
 113
 114
 115
 116
 117
 118
 119
 120 #endif // _Geom2dInt_TheLocateExtPCOfTheProjPCurOfGInter_HeaderFile