src/HLRBRep/HLRBRep_TheLocateExtPCOfTheProjPCurOfCInter.hxx

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