include/opencascade/GeomAPI_IntSS.hxx

0001 // Created on: 1995-03-14
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1995-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 _GeomAPI_IntSS_HeaderFile
0018 #define _GeomAPI_IntSS_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GeomInt_IntSS.hxx>
0025 #include <Standard_Integer.hxx>
0026 class StdFail_NotDone;
0027 class Standard_OutOfRange;
0028 class Geom_Surface;
0029 class Geom_Curve;
0030
0031 //! This class implements methods for
0032 //! computing the intersection curves   between two surfaces.
0033 //! The result is curves from Geom.  The "domain" used for
0034 //! a surface   is the natural  parametric domain
0035 //! unless the surface is a  RectangularTrimmedSurface
0036 //! from Geom.
0037 class GeomAPI_IntSS
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Constructs an empty object. Use the
0043   //! function Perform for further initialization algorithm by two surfaces.
0044   GeomAPI_IntSS();
0045
0046   //! Computes the intersection curves
0047   //! between the two surfaces S1 and S2. Parameter Tol defines the precision
0048   //! of curves computation. For most cases the value 1.0e-7 is recommended to use.
0049   //! Warning
0050   //! Use the function IsDone to verify that the intersections are successfully computed.I
0051   GeomAPI_IntSS(const Handle(Geom_Surface)& S1,
0052                 const Handle(Geom_Surface)& S2,
0053                 const Standard_Real         Tol);
0054
0055   //! Initializes an algorithm with the
0056   //! given arguments and computes the intersection curves between the two surfaces S1 and S2.
0057   //! Parameter Tol defines the precision of curves computation. For most
0058   //! cases the value 1.0e-7 is recommended to use.
0059   //! Warning
0060   //! Use function IsDone to verify that the intersections are successfully computed.
0061   void Perform(const Handle(Geom_Surface)& S1,
0062                const Handle(Geom_Surface)& S2,
0063                const Standard_Real         Tol);
0064
0065   //! Returns True if the intersection was successful.
0066   Standard_Boolean IsDone() const;
0067
0068   //! Returns the number of computed intersection curves.
0069   //! Exceptions
0070   //! StdFail_NotDone if the computation fails.
0071   Standard_Integer NbLines() const;
0072
0073   //! Returns the computed intersection curve of index Index.
0074   //! Exceptions
0075   //! StdFail_NotDone if the computation fails.
0076   //! Standard_OutOfRange if Index is out of range [1, NbLines] where NbLines
0077   //! is the number of computed intersection curves.
0078   const Handle(Geom_Curve)& Line(const Standard_Integer Index) const;
0079
0080 protected:
0081 private:
0082   GeomInt_IntSS myIntersec;
0083 };
0084
0085 #include <GeomAPI_IntSS.lxx>
0086
0087 #endif // _GeomAPI_IntSS_HeaderFile