include/opencascade/Extrema_GenLocateExtSS.hxx

0001 // Created on: 1996-01-22
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1996-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_GenLocateExtSS_HeaderFile
0018 #define _Extrema_GenLocateExtSS_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Extrema_POnSurf.hxx>
0024 class Adaptor3d_Surface;
0025
0026
0027 //! With two close points it calculates the distance
0028 //! between two surfaces.
0029 //! This distance can be a minimum or a maximum.
0030 class Extrema_GenLocateExtSS
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036
0037   Standard_EXPORT Extrema_GenLocateExtSS();
0038
0039   //! Calculates the distance with two close points.
0040   //! The close points are defined by the parameter values
0041   //! (U1,V1) for S1 and (U2,V2) for S2.
0042   //! The function F(u1,v1,u2,v2)=distance(S1(u1,v1),S2(u2,v2))
0043   //! has an extremun when gradient(F)=0. The algorithm searches
0044   //! a zero near the close points.
0045   Standard_EXPORT Extrema_GenLocateExtSS(const Adaptor3d_Surface& S1, const Adaptor3d_Surface& S2, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2, const Standard_Real Tol1, const Standard_Real Tol2);
0046
0047   Standard_EXPORT void Perform (const Adaptor3d_Surface& S1, const Adaptor3d_Surface& S2, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2, const Standard_Real Tol1, const Standard_Real Tol2);
0048
0049   //! Returns True if the distance is found.
0050   Standard_EXPORT Standard_Boolean IsDone() const;
0051
0052   //! Returns the value of the extremum square distance.
0053   Standard_EXPORT Standard_Real SquareDistance() const;
0054
0055   //! Returns the point of the extremum distance on S1.
0056   Standard_EXPORT const Extrema_POnSurf& PointOnS1() const;
0057
0058   //! Returns the point of the extremum distance on S2.
0059   Standard_EXPORT const Extrema_POnSurf& PointOnS2() const;
0060
0061
0062
0063
0064 protected:
0065
0066
0067
0068
0069
0070 private:
0071
0072
0073
0074   Standard_Boolean myDone;
0075   Standard_Real mySqDist;
0076   Extrema_POnSurf myPoint1;
0077   Extrema_POnSurf myPoint2;
0078
0079
0080 };
0081
0082
0083
0084
0085
0086
0087
0088 #endif // _Extrema_GenLocateExtSS_HeaderFile