src/Extrema/Extrema_ExtCC.hxx

   1 // Created on: 1994-07-06
   2 // Created by: Laurent PAINNOT
   3 // Copyright (c) 1994-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_ExtCC_HeaderFile
  18 #define _Extrema_ExtCC_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Extrema_ECC.hxx>
  25 #include <Standard_Boolean.hxx>
  26 #include <Extrema_SequenceOfPOnCurv.hxx>
  27 #include <TColStd_SequenceOfReal.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <Standard_Address.hxx>
  30 #include <Standard_Real.hxx>
  31 #include <gp_Pnt.hxx>
  32
  33 class Adaptor3d_Curve;
  34 class Extrema_POnCurv;
  35 class gp_Pnt;
  36 class Extrema_ExtElC;
  37 class Extrema_ECC;
  38
  39
  40 //! It calculates all the distance between two curves.
  41 //! These distances can be maximum or minimum.
  42 class Extrema_ExtCC
  43 {
  44 public:
  45
  46   DEFINE_STANDARD_ALLOC
  47
  48
  49   Standard_EXPORT Extrema_ExtCC(const Standard_Real TolC1 = 1.0e-10, const Standard_Real TolC2 = 1.0e-10);
  50
  51   //! It calculates all the distances.
  52   Standard_EXPORT Extrema_ExtCC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2, const Standard_Real TolC1 = 1.0e-10, const Standard_Real TolC2 = 1.0e-10);
  53
  54   //! It calculates all the distances.
  55   Standard_EXPORT Extrema_ExtCC(const Adaptor3d_Curve& C1, const Adaptor3d_Curve& C2, const Standard_Real U1, const Standard_Real U2, const Standard_Real V1, const Standard_Real V2, const Standard_Real TolC1 = 1.0e-10, const Standard_Real TolC2 = 1.0e-10);
  56
  57   //! Initializes but does not perform algorithm.
  58   Standard_EXPORT void Initialize (const Adaptor3d_Curve& C1,
  59                                    const Adaptor3d_Curve& C2,
  60                                    const Standard_Real TolC1 = 1.0e-10,
  61                                    const Standard_Real TolC2 = 1.0e-10);
  62
  63   //! Initializes but does not perform algorithm.
  64   Standard_EXPORT void Initialize (const Adaptor3d_Curve& C1,
  65                                    const Adaptor3d_Curve& C2,
  66                                    const Standard_Real U1,
  67                                    const Standard_Real U2,
  68                                    const Standard_Real V1,
  69                                    const Standard_Real V2,
  70                                    const Standard_Real TolC1 = 1.0e-10,
  71                                    const Standard_Real TolC2 = 1.0e-10);
  72
  73   Standard_EXPORT void SetCurve (const Standard_Integer theRank, const Adaptor3d_Curve& C);
  74
  75   Standard_EXPORT void SetCurve (const Standard_Integer theRank, const Adaptor3d_Curve& C, const Standard_Real Uinf, const Standard_Real Usup);
  76
  77   Standard_EXPORT void SetRange (const Standard_Integer theRank, const Standard_Real Uinf, const Standard_Real Usup);
  78
  79   Standard_EXPORT void SetTolerance (const Standard_Integer theRank, const Standard_Real Tol);
  80
  81   Standard_EXPORT void Perform();
  82
  83   //! Returns True if the distances are found.
  84   Standard_EXPORT Standard_Boolean IsDone() const;
  85
  86   //! Returns the number of extremum distances.
  87   Standard_EXPORT Standard_Integer NbExt() const;
  88
  89   //! Returns True if the two curves are parallel.
  90   Standard_EXPORT Standard_Boolean IsParallel() const;
  91
  92   //! Returns the value of the Nth extremum square distance.
  93   Standard_EXPORT Standard_Real SquareDistance (const Standard_Integer N = 1) const;
  94
  95   //! Returns the points of the Nth extremum distance.
  96   //! P1 is on the first curve, P2 on the second one.
  97   Standard_EXPORT void Points (const Standard_Integer N, Extrema_POnCurv& P1, Extrema_POnCurv& P2) const;
  98
  99   //! if the curve is a trimmed curve,
 100   //! dist11 is a square distance between the point on C1
 101   //! of parameter FirstParameter and the point of
 102   //! parameter FirstParameter on C2.
 103   Standard_EXPORT void TrimmedSquareDistances (Standard_Real& dist11, Standard_Real& distP12, Standard_Real& distP21, Standard_Real& distP22, gp_Pnt& P11, gp_Pnt& P12, gp_Pnt& P21, gp_Pnt& P22) const;
 104
 105   //! Set flag for single extrema computation. Works on parametric solver only.
 106   Standard_EXPORT void SetSingleSolutionFlag (const Standard_Boolean theSingleSolutionFlag);
 107
 108   //! Get flag for single extrema computation. Works on parametric solver only.
 109   Standard_EXPORT Standard_Boolean GetSingleSolutionFlag () const;
 110
 111 protected:
 112
 113   //! Prepares the extrema result(s) for analytical cases (line, circle, ellipsis etc.)
 114   Standard_EXPORT void PrepareResults (const Extrema_ExtElC& AlgExt,
 115                                        const Standard_Boolean theIsInverse,
 116                                        const Standard_Real Ut11,
 117                                        const Standard_Real Ut12,
 118                                        const Standard_Real Ut21,
 119                                        const Standard_Real Ut22);
 120
 121   //! Prepares the extrema result(s) for general cases (e.g. with B-spline curves).
 122   Standard_EXPORT void PrepareResults (const Extrema_ECC& AlgExt,
 123                                        const Standard_Real Ut11,
 124                                        const Standard_Real Ut12,
 125                                        const Standard_Real Ut21,
 126                                        const Standard_Real Ut22);
 127
 128   //! Prepares the extrema result(s) in case when the given curves are parallel.
 129   Standard_EXPORT void PrepareParallelResult(const Standard_Real theUt11,
 130                                              const Standard_Real theUt12,
 131                                              const Standard_Real theUt21,
 132                                              const Standard_Real theUt22,
 133                                              const Standard_Real theSqDist);
 134
 135   // Clears all found extremas.
 136   // This method does not change any flags (e.g. Done or IsParallel)
 137   void ClearSolutions()
 138   {
 139     mySqDist.Clear();
 140     mypoints.Clear();
 141   }
 142
 143 private:
 144
 145   // disallow copies
 146   Extrema_ExtCC            (Extrema_ExtCC& ) Standard_DELETE;
 147   Extrema_ExtCC& operator= (Extrema_ExtCC& ) Standard_DELETE;
 148
 149 private:
 150
 151   Standard_Boolean myIsFindSingleSolution; // Default value is false.
 152   Extrema_ECC myECC;
 153   Standard_Boolean myDone;
 154   Standard_Boolean myIsPar;
 155   Extrema_SequenceOfPOnCurv mypoints;
 156   TColStd_SequenceOfReal mySqDist;
 157   const Adaptor3d_Curve* myC[2];
 158   Standard_Real myInf[2];
 159   Standard_Real mySup[2];
 160   Standard_Real myTol[2];
 161   gp_Pnt P1f;
 162   gp_Pnt P1l;
 163   gp_Pnt P2f;
 164   gp_Pnt P2l;
 165   Standard_Real mydist11;
 166   Standard_Real mydist12;
 167   Standard_Real mydist21;
 168   Standard_Real mydist22;
 169
 170 };
 171
 172 #endif // _Extrema_ExtCC_HeaderFile