0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / 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   Standard_EXPORT HLRBRep_TheLocateExtPCOfTheProjPCurOfCInter();
44
45   //! Calculates the distance with a close point.
46   //! The close point is defined by the parameter value U0.
47   //! The function F(u)=distance(P,C(u)) has an extremum when g(u)=dF/du=0.
48   //! The algorithm searches a zero near the close point.
49   //! TolU is used to decide to stop the iterations.
50   //! At the nth iteration, the criteria is:
51   //! abs(Un - Un-1) < TolU.
52   Standard_EXPORT HLRBRep_TheLocateExtPCOfTheProjPCurOfCInter(const gp_Pnt2d& P, const Standard_Address& C, const Standard_Real U0, const Standard_Real TolU);
53   
54   //! Calculates the distance with a close point.
55   //! The close point is defined by the parameter value U0.
56   //! The function F(u)=distance(P,C(u)) has an extremum when g(u)=dF/du=0.
57   //! The algorithm searches a zero near the close point.
58   //! Zeros are searched between Umin and Usup.
59   //! TolU is used to decide to stop the iterations.
60   //! At the nth iteration, the criteria is:
61   //! abs(Un - Un-1) < TolU.
62   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);
63   
64   //! sets the fields of the algorithm.
65   Standard_EXPORT void Initialize (const Standard_Address& C, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real TolU);
66   
67   //! the algorithm is done with the point P.
68   //! An exception is raised if the fields have not
69   //! been initialized.
70   Standard_EXPORT void Perform (const gp_Pnt2d& P, const Standard_Real U0);
71   
72   //! Returns True if the distance is found.
73   Standard_EXPORT Standard_Boolean IsDone() const;
74   
75   //! Returns the value of the extremum square distance.
76   Standard_EXPORT Standard_Real SquareDistance() const;
77   
78   //! Returns True if the extremum distance is a minimum.
79   Standard_EXPORT Standard_Boolean IsMin() const;
80   
81   //! Returns the point of the extremum distance.
82   Standard_EXPORT const Extrema_POnCurv2d& Point() const;
83
84 private:
85
86   Standard_Boolean myDone;
87   Standard_Real mytolU;
88   Standard_Real myumin;
89   Standard_Real myusup;
90   HLRBRep_PCLocFOfTheLocateExtPCOfTheProjPCurOfCInter myF;
91
92 };
93
94 #endif // _HLRBRep_TheLocateExtPCOfTheProjPCurOfCInter_HeaderFile