src/GC/GC_MakeArcOfEllipse.hxx

   1 // Created on: 1992-09-28
   2 // Created by: Remi GILET
   3 // Copyright (c) 1992-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 _GC_MakeArcOfEllipse_HeaderFile
  18 #define _GC_MakeArcOfEllipse_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <GC_Root.hxx>
  25 #include <Geom_TrimmedCurve.hxx>
  26
  27 class StdFail_NotDone;
  28 class gp_Elips;
  29 class gp_Pnt;
  30
  31
  32 //! Implements construction algorithms for an arc
  33 //! of ellipse in 3D space. The result is a Geom_TrimmedCurve curve.
  34 //! A MakeArcOfEllipse object provides a framework for:
  35 //! -   defining the construction of the arc of ellipse,
  36 //! -   implementing the construction algorithm, and
  37 //! -   consulting the results. In particular, the
  38 //! Value function returns the constructed arc of ellipse.
  39 class GC_MakeArcOfEllipse  : public GC_Root
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
  47   //! a Ellipse between two parameters Alpha1 and Alpha2.
  48   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense);
  49
  50   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
  51   //! a Ellipse between point <P> and the angle Alpha
  52   //! given in radians.
  53   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const gp_Pnt& P, const Standard_Real Alpha, const Standard_Boolean Sense);
  54
  55   //! Constructs an arc of Ellipse (TrimmedCurve from Geom) from
  56   //! a Ellipse between two points P1 and P2.
  57   //! The orientation of the arc of ellipse is:
  58   //! -   the sense of Elips if Sense is true, or
  59   //! -   the opposite sense if Sense is false.
  60   //! Notes:
  61   //! -   Alpha1, Alpha2 and Alpha are angle values, given in radians.
  62   //! -   IsDone always returns true.
  63   Standard_EXPORT GC_MakeArcOfEllipse(const gp_Elips& Elips, const gp_Pnt& P1, const gp_Pnt& P2, const Standard_Boolean Sense);
  64
  65   //! Returns the constructed arc of ellipse.
  66   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
  67
  68   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
  69
  70 private:
  71   Handle(Geom_TrimmedCurve) TheArc;
  72 };
  73
  74 #endif // _GC_MakeArcOfEllipse_HeaderFile