include/opencascade/Extrema_LocateExtCC2d.hxx

0001 // Created on: 1994-07-06
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1994-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_LocateExtCC2d_HeaderFile
0018 #define _Extrema_LocateExtCC2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <Extrema_POnCurv2d.hxx>
0026 class Adaptor2d_Curve2d;
0027
0028 //! It calculates the distance between two curves with
0029 //! a close point; these distances can be maximum or
0030 //! minimum.
0031 class Extrema_LocateExtCC2d
0032 {
0033 public:
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Calculates the distance with a close point. The
0037   //! close point is defined by a parameter value on each
0038   //! curve.
0039   //! The function F(u,v)=distance(C1(u),C2(v)) has an
0040   //! extremun when gradient(f)=0. The algorithm searches
0041   //! the zero near the close point.
0042   Standard_EXPORT Extrema_LocateExtCC2d(const Adaptor2d_Curve2d& C1,
0043                                         const Adaptor2d_Curve2d& C2,
0044                                         const double             U0,
0045                                         const double             V0);
0046
0047   //! Returns True if the distance is found.
0048   Standard_EXPORT bool IsDone() const;
0049
0050   //! Returns the value of the extremum square distance.
0051   Standard_EXPORT double SquareDistance() const;
0052
0053   //! Returns the points of the extremum distance.
0054   //! P1 is on the first curve, P2 on the second one.
0055   Standard_EXPORT void Point(Extrema_POnCurv2d& P1, Extrema_POnCurv2d& P2) const;
0056
0057 private:
0058   bool              myDone;
0059   double            mySqDist;
0060   Extrema_POnCurv2d myPoint1;
0061   Extrema_POnCurv2d myPoint2;
0062 };
0063
0064 #endif // _Extrema_LocateExtCC2d_HeaderFile