0032630: Coding - get rid of unsused forward declarations [BinMDF to IFSelect]
[occt.git] / src / GCE2d / GCE2d_MakeArcOfHyperbola.hxx
CommitLineData
42cf5bc1 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>
d1a67b9d 25#include <Geom2d_TrimmedCurve.hxx>
26
42cf5bc1 27class gp_Hypr2d;
28class gp_Pnt2d;
29
30
31//! Implements construction algorithms for an arc of
32//! hyperbola in the plane. The result is a Geom2d_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 Value
37//! function returns the constructed arc of hyperbola.
38class GCE2d_MakeArcOfHyperbola : public GCE2d_Root
39{
40public:
41
42 DEFINE_STANDARD_ALLOC
43
44
45 //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
46 //! a Hyperbola between two parameters Alpha1 and Alpha2.
47 Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense = Standard_True);
48
49 //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
50 //! a Hyperbola between point <P> and the parameter
51 //! Alpha.
52 Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const gp_Pnt2d& P, const Standard_Real Alpha, const Standard_Boolean Sense = Standard_True);
53
54 //! Makes an arc of Hyperbola (TrimmedCurve from Geom2d) from
55 //! a Hyperbola between two points P1 and P2.
56 //! Note: the orientation of the arc of hyperbola is:
57 //! - the trigonometric sense if Sense is not defined or
58 //! is true (default value), or
59 //! - the opposite sense if Sense is false.
60 //! - IsDone always returns true.
61 Standard_EXPORT GCE2d_MakeArcOfHyperbola(const gp_Hypr2d& Hypr, const gp_Pnt2d& P1, const gp_Pnt2d& P2, const Standard_Boolean Sense = Standard_True);
62
63 //! Returns the constructed arc of hyperbola.
64 Standard_EXPORT const Handle(Geom2d_TrimmedCurve)& Value() const;
42cf5bc1 65
d1a67b9d 66 operator const Handle(Geom2d_TrimmedCurve)& () const { return Value(); }
42cf5bc1 67
68private:
42cf5bc1 69 Handle(Geom2d_TrimmedCurve) TheArc;
42cf5bc1 70};
71
42cf5bc1 72#endif // _GCE2d_MakeArcOfHyperbola_HeaderFile