include/opencascade/Extrema_LocECC2d.hxx

0001 // Created on: 1991-02-26
0002 // Created by: Isabelle GRIGNON
0003 // Copyright (c) 1991-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 _Extrema_LocECC2d_HeaderFile
0018 #define _Extrema_LocECC2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Extrema_POnCurv2d.hxx>
0024
0025 class Standard_DomainError;
0026 class StdFail_NotDone;
0027 class Adaptor2d_Curve2d;
0028 class Extrema_Curve2dTool;
0029 class Extrema_POnCurv2d;
0030 class gp_Pnt2d;
0031 class gp_Vec2d;
0032 class Extrema_CCLocFOfLocECC2d;
0033
0034 class Extrema_LocECC2d
0035 {
0036 public:
0037
0038   DEFINE_STANDARD_ALLOC
0039
0040
0041   //! Calculates the distance with a close point. The
0042   //! close point is defined by a parameter value on each
0043   //! curve.
0044   //! The function F(u,v)=distance(C1(u),C2(v)) has an
0045   //! extremun when gradient(f)=0. The algorithm searches
0046   //! the zero near the close point.
0047   Standard_EXPORT Extrema_LocECC2d(const Adaptor2d_Curve2d& C1, const Adaptor2d_Curve2d& C2, const Standard_Real U0, const Standard_Real V0, const Standard_Real TolU, const Standard_Real TolV);
0048
0049   //! Returns True if the distance is found.
0050   Standard_EXPORT Standard_Boolean IsDone() const;
0051
0052   //! Returns the value of the extremum square distance.
0053   Standard_EXPORT Standard_Real SquareDistance() const;
0054
0055   //! Returns the points of the extremum distance.
0056   //! P1 is on the first curve, P2 on the second one.
0057   Standard_EXPORT void Point (Extrema_POnCurv2d& P1, Extrema_POnCurv2d& P2) const;
0058
0059
0060
0061
0062 protected:
0063
0064
0065
0066
0067
0068 private:
0069
0070
0071
0072   Standard_Boolean myDone;
0073   Standard_Real mySqDist;
0074   Extrema_POnCurv2d myPoint1;
0075   Extrema_POnCurv2d myPoint2;
0076
0077
0078 };
0079
0080
0081
0082
0083
0084
0085
0086 #endif // _Extrema_LocECC2d_HeaderFile