include/opencascade/GC_MakeArcOfEllipse.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 _GC_MakeArcOfEllipse_HeaderFile
0018 #define _GC_MakeArcOfEllipse_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GC_Root.hxx>
0025 #include <Geom_TrimmedCurve.hxx>
0026
0027 class gp_Elips;
0028 class gp_Pnt;
0029
0030
0031 //! Implements construction algorithms for an arc
0032 //! of ellipse in 3D space. The result is a Geom_TrimmedCurve curve.
0033 //! A MakeArcOfEllipse object provides a framework for:
0034 //! -   defining the construction of the arc of ellipse,
0035 //! -   implementing the construction algorithm, and
0036 //! -   consulting the results. In particular, the
0037 //! Value function returns the constructed arc of ellipse.
0038 class GC_MakeArcOfEllipse  : public GC_Root
0039 {
0040 public:
0041
0042   DEFINE_STANDARD_ALLOC
0043
0044
0045   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
0046   //! a Ellipse between two parameters Alpha1 and Alpha2.
0047   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense);
0048
0049   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
0050   //! a Ellipse between point <P> and the angle Alpha
0051   //! given in radians.
0052   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const gp_Pnt& P, const Standard_Real Alpha, const Standard_Boolean Sense);
0053
0054   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
0055   //! a Ellipse between two points P1 and P2.
0056   //! The orientation of the arc of ellipse is:
0057   //! -   the sense of Elips if Sense is true, or
0058   //! -   the opposite sense if Sense is false.
0059   //! Notes:
0060   //! -   Alpha1, Alpha2 and Alpha are angle values, given in radians.
0061   //! -   IsDone always returns true.
0062   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const gp_Pnt& P1, const gp_Pnt& P2, const Standard_Boolean Sense);
0063
0064   //! Returns the constructed arc of ellipse.
0065   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
0066
0067   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
0068
0069 private:
0070   Handle(Geom_TrimmedCurve) TheArc;
0071 };
0072
0073 #endif // _GC_MakeArcOfEllipse_HeaderFile