include/opencascade/Convert_TorusToBSplineSurface.hxx

0001 // Created on: 1991-10-10
0002 // Created by: Jean Claude VAUTHIER
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 _Convert_TorusToBSplineSurface_HeaderFile
0018 #define _Convert_TorusToBSplineSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Convert_ElementarySurfaceToBSplineSurface.hxx>
0025 #include <Standard_Boolean.hxx>
0026 class gp_Torus;
0027
0028 //! This algorithm converts a bounded Torus into a rational
0029 //! B-spline surface. The torus is a Torus from package gp.
0030 //! The parametrization of the torus is :
0031 //! P (U, V) =
0032 //! Loc  +  MinorRadius * Sin(V) * Zdir +
0033 //! (MajorRadius+MinorRadius*Cos(V)) *  (Cos(U)*Xdir + Sin(U)*Ydir)
0034 //! where Loc is the center of the torus, Xdir, Ydir and Zdir are the
0035 //! normalized directions of the local cartesian coordinate system of
0036 //! the Torus. The parametrization range is U [0, 2PI], V [0, 2PI].
0037 //! KeyWords :
0038 //! Convert, Torus, BSplineSurface.
0039 class Convert_TorusToBSplineSurface : public Convert_ElementarySurfaceToBSplineSurface
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! The equivalent B-spline surface as the same orientation as the
0045   //! torus in the U and V parametric directions.
0046   //!
0047   //! Raised if U1 = U2 or U1 = U2 + 2.0 * Pi
0048   //! Raised if V1 = V2 or V1 = V2 + 2.0 * Pi
0049   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus&     T,
0050                                                 const Standard_Real U1,
0051                                                 const Standard_Real U2,
0052                                                 const Standard_Real V1,
0053                                                 const Standard_Real V2);
0054
0055   //! The equivalent B-spline surface as the same orientation as the
0056   //! torus in the U and V parametric directions.
0057   //!
0058   //! Raised if Param1 = Param2 or Param1 = Param2 + 2.0 * Pi
0059   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus&        T,
0060                                                 const Standard_Real    Param1,
0061                                                 const Standard_Real    Param2,
0062                                                 const Standard_Boolean UTrim = Standard_True);
0063
0064   //! The equivalent B-spline surface as the same orientation as the
0065   //! torus in the U and V parametric directions.
0066   Standard_EXPORT Convert_TorusToBSplineSurface(const gp_Torus& T);
0067
0068 protected:
0069 private:
0070 };
0071
0072 #endif // _Convert_TorusToBSplineSurface_HeaderFile