src/IntAna/IntAna_IntLinTorus.hxx

   1 // Created on: 1991-05-16
   2 // Created by: Isabelle GRIGNON
   3 // Copyright (c) 1991-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IntAna_IntLinTorus_HeaderFile
  18 #define _IntAna_IntLinTorus_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <gp_Pnt.hxx>
  27 #include <Standard_Real.hxx>
  28 class StdFail_NotDone;
  29 class Standard_OutOfRange;
  30 class gp_Lin;
  31 class gp_Torus;
  32 class gp_Pnt;
  33
  34
  35 //! Intersection between a line and a torus.
  36 class IntAna_IntLinTorus
  37 {
  38 public:
  39
  40   DEFINE_STANDARD_ALLOC
  41
  42
  43   Standard_EXPORT IntAna_IntLinTorus();
  44
  45   //! Creates the intersection between a line and a torus.
  46   Standard_EXPORT IntAna_IntLinTorus(const gp_Lin& L, const gp_Torus& T);
  47
  48   //! Intersects a line and a torus.
  49   Standard_EXPORT void Perform (const gp_Lin& L, const gp_Torus& T);
  50
  51   //! Returns True if the computation was successful.
  52     Standard_Boolean IsDone() const;
  53
  54   //! Returns the number of intersection points.
  55     Standard_Integer NbPoints() const;
  56
  57   //! Returns the intersection point of range Index.
  58     const gp_Pnt& Value (const Standard_Integer Index) const;
  59
  60   //! Returns the parameter on the line of the intersection
  61   //! point of range Index.
  62     Standard_Real ParamOnLine (const Standard_Integer Index) const;
  63
  64   //! Returns the parameters on the torus of the intersection
  65   //! point of range Index.
  66     void ParamOnTorus (const Standard_Integer Index, Standard_Real& FI, Standard_Real& THETA) const;
  67
  68
  69
  70
  71 protected:
  72
  73
  74
  75
  76
  77 private:
  78
  79
  80
  81   Standard_Boolean done;
  82   Standard_Integer nbpt;
  83   gp_Pnt thePoint[4];
  84   Standard_Real theParam[4];
  85   Standard_Real theFi[4];
  86   Standard_Real theTheta[4];
  87
  88
  89 };
  90
  91
  92 #include <IntAna_IntLinTorus.lxx>
  93
  94
  95
  96
  97
  98 #endif // _IntAna_IntLinTorus_HeaderFile