include/opencascade/Convert_CircleToBSplineCurve.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_CircleToBSplineCurve_HeaderFile
0018 #define _Convert_CircleToBSplineCurve_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Convert_ConicToBSplineCurve.hxx>
0025 #include <Convert_ParameterisationType.hxx>
0026 class gp_Circ2d;
0027
0028 //! This algorithm converts a circle into a rational B-spline curve.
0029 //! The circle is a Circ2d from package gp and its parametrization is :
0030 //! P (U) = Loc + R * (Cos(U) * Xdir + Sin(U) * YDir) where Loc is the
0031 //! center of the circle Xdir and Ydir are the normalized directions
0032 //! of the local cartesian coordinate system of the circle.
0033 //! The parametrization range for the circle is U [0, 2Pi].
0034 //!
0035 //! Warnings :
0036 //! The parametrization range for the B-spline curve is not [0, 2Pi].
0037 //!
0038 //! KeyWords :
0039 //! Convert, Circle, BSplineCurve, 2D .
0040 class Convert_CircleToBSplineCurve : public Convert_ConicToBSplineCurve
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! The equivalent B-spline curve has the same orientation
0046   //! as the circle C.
0047   Standard_EXPORT Convert_CircleToBSplineCurve(
0048     const gp_Circ2d&                   C,
0049     const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);
0050
0051   //! The circle C is limited between the parametric values U1, U2
0052   //! in radians. U1 and U2 [0.0, 2*Pi] .
0053   //! The equivalent B-spline curve is oriented from U1 to U2 and has
0054   //! the same orientation as the circle C.
0055   //!
0056   //! Raised if U1 = U2 or U1 = U2 + 2.0 * Pi
0057   Standard_EXPORT Convert_CircleToBSplineCurve(
0058     const gp_Circ2d&                   C,
0059     const Standard_Real                U1,
0060     const Standard_Real                U2,
0061     const Convert_ParameterisationType Parameterisation = Convert_TgtThetaOver2);
0062
0063 protected:
0064 private:
0065 };
0066
0067 #endif // _Convert_CircleToBSplineCurve_HeaderFile