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