include/opencascade/GCE2d_MakeArcOfCircle.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-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 _GCE2d_MakeArcOfCircle_HeaderFile
0018 #define _GCE2d_MakeArcOfCircle_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GCE2d_Root.hxx>
0025 #include <Geom2d_TrimmedCurve.hxx>
0026
0027 class gp_Circ2d;
0028 class gp_Pnt2d;
0029 class gp_Vec2d;
0030
0031
0032 //! Implements construction algorithms for an arc of
0033 //! circle in the plane. The result is a Geom2d_TrimmedCurve curve.
0034 //! A MakeArcOfCircle object provides a framework for:
0035 //! -   defining the construction of the arc of circle,
0036 //! -   implementing the construction algorithm, and
0037 //! -   consulting the results. In particular, the Value
0038 //! function returns the constructed arc of circle.
0039 class GCE2d_MakeArcOfCircle  : public GCE2d_Root
0040 {
0041 public:
0042
0043   DEFINE_STANDARD_ALLOC
0044
0045
0046   //! Makes an arc of circle (TrimmedCurve from Geom2d) from
0047   //! a circle between two parameters Alpha1 and Alpha2.
0048   //! The two parameters are angles. The parameters are
0049   //! in radians.
0050   Standard_EXPORT GCE2d_MakeArcOfCircle(const gp_Circ2d& Circ, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense = Standard_True);
0051
0052   //! Makes an arc of circle (TrimmedCurve from Geom2d) from
0053   //! a circle between point <P> and the parameter
0054   //! Alpha. Alpha is given in radians.
0055   Standard_EXPORT GCE2d_MakeArcOfCircle(const gp_Circ2d& Circ, const gp_Pnt2d& P, const Standard_Real Alpha, const Standard_Boolean Sense = Standard_True);
0056
0057   //! Makes an arc of circle (TrimmedCurve from Geom2d) from
0058   //! a circle between two points P1 and P2.
0059   Standard_EXPORT GCE2d_MakeArcOfCircle(const gp_Circ2d& Circ, const gp_Pnt2d& P1, const gp_Pnt2d& P2, const Standard_Boolean Sense = Standard_True);
0060
0061   //! Makes an arc of circle (TrimmedCurve from Geom2d) from
0062   //! three points P1,P2,P3 between two points P1 and P3,
0063   //! and passing through the point P2.
0064   Standard_EXPORT GCE2d_MakeArcOfCircle(const gp_Pnt2d& P1, const gp_Pnt2d& P2, const gp_Pnt2d& P3);
0065
0066   //! Makes an arc of circle (TrimmedCurve from Geom2d) from
0067   //! two points P1,P2 and the tangente to the solution at
0068   //! the point P1.
0069   Standard_EXPORT GCE2d_MakeArcOfCircle(const gp_Pnt2d& P1, const gp_Vec2d& V, const gp_Pnt2d& P2);
0070
0071   //! Returns the constructed arc of circle.
0072   //! Exceptions StdFail_NotDone if no arc of circle is constructed.
0073   Standard_EXPORT const Handle(Geom2d_TrimmedCurve)& Value() const;
0074
0075   operator const Handle(Geom2d_TrimmedCurve)& () const { return Value(); }
0076
0077 private:
0078   Handle(Geom2d_TrimmedCurve) TheArc;
0079 };
0080
0081 #endif // _GCE2d_MakeArcOfCircle_HeaderFile