src/GC/GC_MakeArcOfHyperbola.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_MakeArcOfHyperbola_HeaderFile
  18 #define _GC_MakeArcOfHyperbola_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 gp_Hypr;
  28 class gp_Pnt;
  29
  30
  31 //! Implements construction algorithms for an arc
  32 //! of hyperbola in 3D space. The result is a Geom_TrimmedCurve curve.
  33 //! A MakeArcOfHyperbola object provides a framework for:
  34 //! -   defining the construction of the arc of hyperbola,
  35 //! -   implementing the construction algorithm, and
  36 //! -   consulting the results. In particular, the
  37 //! Value function returns the constructed arc of hyperbola.
  38 class GC_MakeArcOfHyperbola  : public GC_Root
  39 {
  40 public:
  41
  42   DEFINE_STANDARD_ALLOC
  43
  44
  45   //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  46   //! a Hyperbola between two parameters Alpha1 and Alpha2
  47   //! (given in radians).
  48   Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense);
  49
  50   //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  51   //! a Hyperbola between point <P> and the parameter
  52   //! Alpha (given in radians).
  53   Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const gp_Pnt& P, const Standard_Real Alpha, const Standard_Boolean Sense);
  54
  55   //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  56   //! a Hyperbola between two points P1 and P2.
  57   //! The orientation of the arc of hyperbola is:
  58   //! -   the sense of Hypr if Sense is true, or
  59   //! -   the opposite sense if Sense is false.
  60   Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const gp_Pnt& P1, const gp_Pnt& P2, const Standard_Boolean Sense);
  61
  62   //! Returns the constructed arc of hyperbola.
  63   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
  64
  65   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
  66
  67 private:
  68   Handle(Geom_TrimmedCurve) TheArc;
  69 };
  70
  71
  72 #endif // _GC_MakeArcOfHyperbola_HeaderFile