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