2393933597669ab0bb505e35b16ab74e598352b4
[occt.git] / src / GCE2d / GCE2d_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 _GCE2d_MakeArcOfHyperbola_HeaderFile
18 #define _GCE2d_MakeArcOfHyperbola_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <GCE2d_Root.hxx>
25 #include <Geom2d_TrimmedCurve.hxx>
26
27 class StdFail_NotDone;
28 class gp_Hypr2d;
29 class gp_Pnt2d;
30
31
32 //! Implements construction algorithms for an arc of
33 //! hyperbola in the plane. The result is a Geom2d_TrimmedCurve curve.
34 //! A MakeArcOfHyperbola object provides a framework for:
35 //! -   defining the construction of the arc of hyperbola,
36 //! -   implementing the construction algorithm, and
37 //! -   consulting the results. In particular, the Value
38 //! function returns the constructed arc of hyperbola.
39 class GCE2d_MakeArcOfHyperbola  : public GCE2d_Root
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   
46   //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
47   //! a Hyperbola between two parameters Alpha1 and Alpha2.
48   Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense = Standard_True);
49   
50   //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
51   //! a Hyperbola between point <P> and the parameter
52   //! Alpha.
53   Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const gp_Pnt2d& P, const Standard_Real Alpha, const Standard_Boolean Sense = Standard_True);
54   
55   //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
56   //! a Hyperbola between two points P1 and P2.
57   //! Note: the orientation of the arc of hyperbola is:
58   //! -   the trigonometric sense if Sense is not defined or
59   //! is true (default value), or
60   //! -   the opposite sense if Sense is false.
61   //! - IsDone always returns true.
62   Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const gp_Pnt2d& P1, const gp_Pnt2d& P2, const Standard_Boolean Sense = Standard_True);
63   
64   //! Returns the constructed arc of hyperbola.
65   Standard_EXPORT const Handle(Geom2d_TrimmedCurve)& Value() const;
66
67   operator const Handle(Geom2d_TrimmedCurve)& () const { return Value(); }
68   operator const Handle(Geom2d_Curve)& () const { return Value(); }
69
70 private:
71   Handle(Geom2d_TrimmedCurve) TheArc;
72 };
73
74 #endif // _GCE2d_MakeArcOfHyperbola_HeaderFile