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
0029 //! Intersection between a line and a torus.
0030 class IntAna_IntLinTorus
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036
0037   Standard_EXPORT IntAna_IntLinTorus();
0038
0039   //! Creates the intersection between a line and a torus.
0040   Standard_EXPORT IntAna_IntLinTorus(const gp_Lin& L, const gp_Torus& T);
0041
0042   //! Intersects a line and a torus.
0043   Standard_EXPORT void Perform (const gp_Lin& L, const gp_Torus& T);
0044
0045   //! Returns True if the computation was successful.
0046     Standard_Boolean IsDone() const;
0047
0048   //! Returns the number of intersection points.
0049     Standard_Integer NbPoints() const;
0050
0051   //! Returns the intersection point of range Index.
0052     const gp_Pnt& Value (const Standard_Integer Index) const;
0053
0054   //! Returns the parameter on the line of the intersection
0055   //! point of range Index.
0056     Standard_Real ParamOnLine (const Standard_Integer Index) const;
0057
0058   //! Returns the parameters on the torus of the intersection
0059   //! point of range Index.
0060     void ParamOnTorus (const Standard_Integer Index, Standard_Real& FI, Standard_Real& THETA) const;
0061
0062
0063
0064
0065 protected:
0066
0067
0068
0069
0070
0071 private:
0072
0073
0074
0075   Standard_Boolean done;
0076   Standard_Integer nbpt;
0077   gp_Pnt thePoint[4];
0078   Standard_Real theParam[4];
0079   Standard_Real theFi[4];
0080   Standard_Real theTheta[4];
0081
0082
0083 };
0084
0085
0086 #include <IntAna_IntLinTorus.lxx>
0087
0088
0089
0090
0091
0092 #endif // _IntAna_IntLinTorus_HeaderFile