summaryrefslogtreecommitdiff
path: root/inc/GCE2d_MakeHyperbola.hxx
blob: 3454de461ed8efa276f4b070c60175334743f5ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _GCE2d_MakeHyperbola_HeaderFile
#define _GCE2d_MakeHyperbola_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Handle_Geom2d_Hyperbola_HeaderFile
#include <Handle_Geom2d_Hyperbola.hxx>
#endif
#ifndef _GCE2d_Root_HeaderFile
#include <GCE2d_Root.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Geom2d_Hyperbola;
class StdFail_NotDone;
class gp_Hypr2d;
class gp_Ax2d;
class gp_Ax22d;
class gp_Pnt2d;


//!This class implements the following algorithms used to <br>
//!          create Hyperbola from Geom2d. <br>
//!          * Create an Hyperbola from two apex  and the center. <br>
//!  Defines the main branch of an hyperbola. <br>
//!  The parameterization range is ]-infinite,+infinite[ <br>
//!  It is possible to get the other branch and the two conjugate <br>
//!  branches of the main branch. <br>
class GCE2d_MakeHyperbola  : public GCE2d_Root {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  
//!  Creates  an Hyperbola from a non persistent one from package gp <br>
  Standard_EXPORT   GCE2d_MakeHyperbola(const gp_Hypr2d& H);
  
//!  MajorAxis is the "XAxis" of the hyperbola. <br>
//!  The major radius of the hyperbola is on this "XAxis" and <br>
//!  the minor radius is on the "YAxis" of the hyperbola. <br>
//!  The status is "NegativeRadius" if MajorRadius < 0.0 or if <br>
//!  MinorRadius < 0.0 <br>
  Standard_EXPORT   GCE2d_MakeHyperbola(const gp_Ax2d& MajorAxis,const Standard_Real MajorRadius,const Standard_Real MinorRadius,const Standard_Boolean Sense);
  
//!  Axis is the local coordinate system of the hyperbola. <br>
//!  The major radius of the hyperbola is on this "XAxis" and <br>
//!  the minor radius is on the "YAxis" of the hyperbola. <br>
//!  The status is "NegativeRadius" if MajorRadius < 0.0 or if <br>
//!  MinorRadius < 0.0 <br>
  Standard_EXPORT   GCE2d_MakeHyperbola(const gp_Ax22d& Axis,const Standard_Real MajorRadius,const Standard_Real MinorRadius);
  //! Creates a hyperbol centered on the origin of the coordinate system <br>
//!  Axis, with major and minor radii MajorRadius and <br>
//!   MinorRadius, where the major axis is the "X Axis" <br>
//!   of Axis (Axis is the local coordinate system of the hyperbola). <br>
//!   The implicit orientation of the ellipse is: <br>
//! -   the sense defined by Axis or H, <br>
//! -   the sense defined by points Center, S1 and S2, <br>
//! -   the trigonometric sense if Sense is not given or is true, or <br>
//! -   the opposite sense if Sense is false. <br>
//! Warning <br>
//! If an error occurs (that is, when IsDone returns <br>
//! false), the Status function returns: <br>
//! -   gce_NegativeRadius if MajorRadius or <br>
//!   MinorRadius is less than 0.0, or <br>
//! -   gce_InvertAxis if the major radius defined by <br>
//!   Center and S1 is less than the minor radius <br>
//!   defined by Center, S1 and S2.Make an Hyperbola with its center and two apexes. <br>
  Standard_EXPORT   GCE2d_MakeHyperbola(const gp_Pnt2d& S1,const gp_Pnt2d& S2,const gp_Pnt2d& Center);
  //! Returns the constructed hyperbola. <br>
//! Exceptions: StdFail_NotDone if no hyperbola is constructed. <br>
  Standard_EXPORT    const Handle_Geom2d_Hyperbola& Value() const;
  
  Standard_EXPORT    const Handle_Geom2d_Hyperbola& Operator() const;
Standard_EXPORT operator Handle_Geom2d_Hyperbola() const;





protected:





private:



Handle_Geom2d_Hyperbola TheHyperbola;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif