0032806: Coding - get rid of unused headers [Contap to Extrema]
[occt.git] / src / Convert / Convert_TorusToBSplineSurface.hxx
1 // Created on: 1991-10-10
2 // Created by: Jean Claude VAUTHIER
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 _Convert_TorusToBSplineSurface_HeaderFile
18 #define _Convert_TorusToBSplineSurface_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Convert_ElementarySurfaceToBSplineSurface.hxx>
25 #include <Standard_Boolean.hxx>
26 class gp_Torus;
27
28
29
30 //! This algorithm converts a bounded Torus into a rational
31 //! B-spline surface. The torus is a Torus from package gp.
32 //! The parametrization of the torus is :
33 //! P (U, V) =
34 //! Loc  +  MinorRadius * Sin(V) * Zdir +
35 //! (MajorRadius+MinorRadius*Cos(V)) *  (Cos(U)*Xdir + Sin(U)*Ydir)
36 //! where Loc is the center of the torus, Xdir, Ydir and Zdir are the
37 //! normalized directions of the local cartesian coordinate system of
38 //! the Torus. The parametrization range is U [0, 2PI], V [0, 2PI].
39 //! KeyWords :
40 //! Convert, Torus, BSplineSurface.
41 class Convert_TorusToBSplineSurface  : public Convert_ElementarySurfaceToBSplineSurface
42 {
43 public:
44
45   DEFINE_STANDARD_ALLOC
46
47   
48
49   //! The equivalent B-spline surface as the same orientation as the
50   //! torus in the U and V parametric directions.
51   //!
52   //! Raised if U1 = U2 or U1 = U2 + 2.0 * Pi
53   //! Raised if V1 = V2 or V1 = V2 + 2.0 * Pi
54   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus& T, const Standard_Real U1, const Standard_Real U2, const Standard_Real V1, const Standard_Real V2);
55   
56
57   //! The equivalent B-spline surface as the same orientation as the
58   //! torus in the U and V parametric directions.
59   //!
60   //! Raised if Param1 = Param2 or Param1 = Param2 + 2.0 * Pi
61   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus& T, const Standard_Real Param1, const Standard_Real Param2, const Standard_Boolean UTrim = Standard_True);
62   
63
64   //! The equivalent B-spline surface as the same orientation as the
65   //! torus in the U and V parametric directions.
66   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus& T);
67
68
69
70
71 protected:
72
73
74
75
76
77 private:
78
79
80
81
82
83 };
84
85
86
87
88
89
90
91 #endif // _Convert_TorusToBSplineSurface_HeaderFile