include/opencascade/Extrema_ExtElSS.hxx

0001 // Created on: 1992-07-22
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1992-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_ExtElSS_HeaderFile
0018 #define _Extrema_ExtElSS_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Boolean.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <NCollection_Array1.hxx>
0027 #include <NCollection_HArray1.hxx>
0028 #include <Extrema_POnSurf.hxx>
0029 #include <Standard_Real.hxx>
0030
0031 class gp_Pln;
0032 class gp_Sphere;
0033 class gp_Cylinder;
0034 class gp_Cone;
0035 class gp_Torus;
0036 class Extrema_POnSurf;
0037
0038 //! It calculates all the distances between 2 elementary
0039 //! surfaces.
0040 //! These distances can be maximum or minimum.
0041 class Extrema_ExtElSS
0042 {
0043 public:
0044   DEFINE_STANDARD_ALLOC
0045
0046   Standard_EXPORT Extrema_ExtElSS();
0047
0048   //! Calculates the distances between 2 planes.
0049   //! These planes can be parallel.
0050   Standard_EXPORT Extrema_ExtElSS(const gp_Pln& S1, const gp_Pln& S2);
0051
0052   Standard_EXPORT void Perform(const gp_Pln& S1, const gp_Pln& S2);
0053
0054   //! Calculates the distances between a plane
0055   //! and a sphere.
0056   Standard_EXPORT Extrema_ExtElSS(const gp_Pln& S1, const gp_Sphere& S2);
0057
0058   Standard_EXPORT void Perform(const gp_Pln& S1, const gp_Sphere& S2);
0059
0060   //! Calculates the distances between 2 spheres.
0061   //! These spheres can be parallel.
0062   Standard_EXPORT Extrema_ExtElSS(const gp_Sphere& S1, const gp_Sphere& S2);
0063
0064   Standard_EXPORT void Perform(const gp_Sphere& S1, const gp_Sphere& S2);
0065
0066   //! Calculates the distances between a sphere
0067   //! and a cylinder.
0068   Standard_EXPORT Extrema_ExtElSS(const gp_Sphere& S1, const gp_Cylinder& S2);
0069
0070   Standard_EXPORT void Perform(const gp_Sphere& S1, const gp_Cylinder& S2);
0071
0072   //! Calculates the distances between a sphere
0073   //! and a cone.
0074   Standard_EXPORT Extrema_ExtElSS(const gp_Sphere& S1, const gp_Cone& S2);
0075
0076   Standard_EXPORT void Perform(const gp_Sphere& S1, const gp_Cone& S2);
0077
0078   //! Calculates the distances between a sphere
0079   //! and a torus.
0080   Standard_EXPORT Extrema_ExtElSS(const gp_Sphere& S1, const gp_Torus& S2);
0081
0082   Standard_EXPORT void Perform(const gp_Sphere& S1, const gp_Torus& S2);
0083
0084   //! Returns True if the distances are found.
0085   Standard_EXPORT bool IsDone() const;
0086
0087   //! Returns True if the two surfaces are parallel.
0088   Standard_EXPORT bool IsParallel() const;
0089
0090   //! Returns the number of extremum distances.
0091   Standard_EXPORT int NbExt() const;
0092
0093   //! Returns the value of the Nth extremum square distance.
0094   Standard_EXPORT double SquareDistance(const int N = 1) const;
0095
0096   //! Returns the points for the Nth resulting distance.
0097   //! P1 is on the first surface, P2 on the second one.
0098   Standard_EXPORT void Points(const int N, Extrema_POnSurf& P1, Extrema_POnSurf& P2) const;
0099
0100 private:
0101   bool                                              myDone;
0102   bool                                              myIsPar;
0103   int                                               myNbExt;
0104   occ::handle<NCollection_HArray1<double>>          mySqDist;
0105   occ::handle<NCollection_HArray1<Extrema_POnSurf>> myPOnS1;
0106   occ::handle<NCollection_HArray1<Extrema_POnSurf>> myPOnS2;
0107 };
0108
0109 #endif // _Extrema_ExtElSS_HeaderFile