0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / GC / GC_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 _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 <Standard_Real.hxx>
26#include <Standard_Boolean.hxx>
27class Geom_TrimmedCurve;
28class StdFail_NotDone;
29class gp_Hypr;
30class gp_Pnt;
31
32
33//! Implements construction algorithms for an arc
34//! of hyperbola in 3D space. The result is a Geom_TrimmedCurve curve.
35//! A MakeArcOfHyperbola object provides a framework for:
36//! - defining the construction of the arc of hyperbola,
37//! - implementing the construction algorithm, and
38//! - consulting the results. In particular, the
39//! Value function returns the constructed arc of hyperbola.
40class GC_MakeArcOfHyperbola : public GC_Root
41{
42public:
43
44 DEFINE_STANDARD_ALLOC
45
46
47 //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
48 //! a Hyperbola between two parameters Alpha1 and Alpha2
49 //! (given in radians).
50 Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense);
51
52 //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
53 //! a Hyperbola between point <P> and the parameter
54 //! Alpha (given in radians).
55 Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const gp_Pnt& P, const Standard_Real Alpha, const Standard_Boolean Sense);
56
57 //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
58 //! a Hyperbola between two points P1 and P2.
59 //! The orientation of the arc of hyperbola is:
60 //! - the sense of Hypr if Sense is true, or
61 //! - the opposite sense if Sense is false.
62 Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr, const gp_Pnt& P1, const gp_Pnt& P2, const Standard_Boolean Sense);
63
64 //! Returns the constructed arc of hyperbola.
65 Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
66operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
67
68
69
70
71protected:
72
73
74
75
76
77private:
78
79
80
81 Handle(Geom_TrimmedCurve) TheArc;
82
83
84};
85
86
87
88
89
90
91
92#endif // _GC_MakeArcOfHyperbola_HeaderFile