src/Extrema/Extrema_ExtElC.hxx

   1 // Created on: 1991-02-21
   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_ExtElC_HeaderFile
  18 #define _Extrema_ExtElC_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_Integer.hxx>
  26 #include <Standard_Real.hxx>
  27 #include <Extrema_POnCurv.hxx>
  28
  29 class gp_Lin;
  30 class gp_Circ;
  31 class gp_Elips;
  32 class gp_Hypr;
  33 class gp_Parab;
  34 class Extrema_POnCurv;
  35
  36
  37 //! It calculates all the distance between two elementary
  38 //! curves.
  39 //! These distances can be maximum or minimum.
  40 class Extrema_ExtElC
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47   Standard_EXPORT Extrema_ExtElC();
  48
  49   //! Calculates the distance between two lines.
  50   //! AngTol is used to test if the lines are parallel:
  51   //! Angle(C1,C2) < AngTol.
  52   Standard_EXPORT Extrema_ExtElC(const gp_Lin& C1, const gp_Lin& C2, const Standard_Real AngTol);
  53
  54   //! Calculates the distance between a line and a
  55   //! circle.
  56   Standard_EXPORT Extrema_ExtElC(const gp_Lin& C1, const gp_Circ& C2, const Standard_Real Tol);
  57
  58   //! Calculates the distance between a line and an
  59   //! elipse.
  60   Standard_EXPORT Extrema_ExtElC(const gp_Lin& C1, const gp_Elips& C2);
  61
  62   //! Calculates the distance between a line and a
  63   //! hyperbola.
  64   Standard_EXPORT Extrema_ExtElC(const gp_Lin& C1, const gp_Hypr& C2);
  65
  66   //! Calculates the distance between a line and a
  67   //! parabola.
  68   Standard_EXPORT Extrema_ExtElC(const gp_Lin& C1, const gp_Parab& C2);
  69
  70   //! Calculates the distance between two circles.
  71   //! The circles can be parallel or identical.
  72   Standard_EXPORT Extrema_ExtElC(const gp_Circ& C1, const gp_Circ& C2);
  73
  74   //! Returns True if the distances are found.
  75   Standard_EXPORT Standard_Boolean IsDone() const;
  76
  77   //! Returns True if the two curves are parallel.
  78   Standard_EXPORT Standard_Boolean IsParallel() const;
  79
  80   //! Returns the number of extremum distances.
  81   Standard_EXPORT Standard_Integer NbExt() const;
  82
  83   //! Returns the value of the Nth extremum square distance.
  84   Standard_EXPORT Standard_Real SquareDistance (const Standard_Integer N = 1) const;
  85
  86   //! Returns the points of the Nth extremum distance.
  87   //! P1 is on the first curve, P2 on the second one.
  88   Standard_EXPORT void Points (const Standard_Integer N, Extrema_POnCurv& P1, Extrema_POnCurv& P2) const;
  89
  90
  91
  92
  93 protected:
  94
  95   //! Computes extrema in case when considered line and circle are in one plane
  96   Standard_EXPORT Standard_Boolean PlanarLineCircleExtrema(const gp_Lin& C1,
  97                                                            const gp_Circ& C2);
  98
  99
 100
 101
 102 private:
 103
 104
 105
 106   Standard_Boolean myDone;
 107   Standard_Boolean myIsPar;
 108   Standard_Integer myNbExt;
 109   Standard_Real mySqDist[6];
 110   Extrema_POnCurv myPoint[6][2];
 111
 112
 113 };
 114
 115
 116
 117
 118
 119
 120
 121 #endif // _Extrema_ExtElC_HeaderFile