src/Extrema/Extrema_LocECC.hxx

   1 // Created on: 1991-02-26
   2 // Created by: Isabelle GRIGNON
   3 // Copyright (c) 1991-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 _Extrema_LocECC_HeaderFile
  18 #define _Extrema_LocECC_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 <Extrema_POnCurv.hxx>
  27 #include <Extrema_SequenceOfPOnCurv.hxx>
  28
  29 class Standard_DomainError;
  30 class StdFail_NotDone;
  31 class Adaptor3d_Curve;
  32 class Extrema_CurveTool;
  33 class Extrema_POnCurv;
  34 class gp_Pnt;
  35 class gp_Vec;
  36 class Extrema_CCLocFOfLocECC;
  37
  38 class Extrema_LocECC
  39 {
  40 public:
  41
  42   DEFINE_STANDARD_ALLOC
  43
  44
  45   //! Calculates the distance with a close point. The
  46   //! close point is defined by a parameter value on each
  47   //! curve.
  48   //! The function F(u,v)=distance(C1(u),C2(v)) has an
  49   //! extremun when gradient(f)=0. The algorithm searchs
  50   //! the zero near the close point.
  51   Standard_EXPORT Extrema_LocECC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2, const Standard_Real U0, const Standard_Real V0, const Standard_Real TolU, const Standard_Real TolV);
  52
  53   //! Returns True if the distance is found.
  54   Standard_EXPORT Standard_Boolean IsDone() const;
  55
  56   //! Returns the value of the extremum square distance.
  57   Standard_EXPORT Standard_Real SquareDistance() const;
  58
  59   //! Returns the points of the extremum distance.
  60   //! P1 is on the first curve, P2 on the second one.
  61   Standard_EXPORT void Point (Extrema_POnCurv& P1, Extrema_POnCurv& P2) const;
  62
  63
  64
  65
  66 protected:
  67
  68
  69
  70
  71
  72 private:
  73
  74
  75
  76   Standard_Boolean myDone;
  77   Standard_Real mySqDist;
  78   Extrema_POnCurv myPoint1;
  79   Extrema_POnCurv myPoint2;
  80
  81
  82 };
  83
  84
  85
  86
  87
  88
  89
  90 #endif // _Extrema_LocECC_HeaderFile