include/opencascade/IntAna_IntLinTorus.hxx

0001 // Created on: 1991-05-16
0002 // Created by: Isabelle GRIGNON
0003 // Copyright (c) 1991-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 _IntAna_IntLinTorus_HeaderFile
0018 #define _IntAna_IntLinTorus_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <gp_Pnt.hxx>
0025 class gp_Lin;
0026 class gp_Torus;
0027
0028 //! Intersection between a line and a torus.
0029 class IntAna_IntLinTorus
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   Standard_EXPORT IntAna_IntLinTorus();
0035
0036   //! Creates the intersection between a line and a torus.
0037   Standard_EXPORT IntAna_IntLinTorus(const gp_Lin& L, const gp_Torus& T);
0038
0039   //! Intersects a line and a torus.
0040   Standard_EXPORT void Perform(const gp_Lin& L, const gp_Torus& T);
0041
0042   //! Returns True if the computation was successful.
0043   bool IsDone() const;
0044
0045   //! Returns the number of intersection points.
0046   int NbPoints() const;
0047
0048   //! Returns the intersection point of range Index.
0049   const gp_Pnt& Value(const int Index) const;
0050
0051   //! Returns the parameter on the line of the intersection
0052   //! point of range Index.
0053   double ParamOnLine(const int Index) const;
0054
0055   //! Returns the parameters on the torus of the intersection
0056   //! point of range Index.
0057   void ParamOnTorus(const int Index, double& FI, double& THETA) const;
0058
0059 private:
0060   bool   done;
0061   int    nbpt;
0062   gp_Pnt thePoint[4];
0063   double theParam[4];
0064   double theFi[4];
0065   double theTheta[4];
0066 };
0067
0068 #include <IntAna_IntLinTorus.lxx>
0069
0070 #endif // _IntAna_IntLinTorus_HeaderFile