OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKGeomBase
GCE2d


GCE2d_MakeHyperbola Class Reference

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

#include <GCE2d_MakeHyperbola.hxx>

Inheritance diagram for GCE2d_MakeHyperbola:

Inheritance graph
[legend]

Public Member Functions

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

Private Attributes

Handle_Geom2d_Hyperbola TheHyperbola

Constructor & Destructor Documentation

Standard_EXPORT GCE2d_MakeHyperbola::GCE2d_MakeHyperbola const gp_Hypr2d &  H  ) 
 

Standard_EXPORT GCE2d_MakeHyperbola::GCE2d_MakeHyperbola const gp_Ax2d &  MajorAxis,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius,
const Standard_Boolean  Sense
 

Standard_EXPORT GCE2d_MakeHyperbola::GCE2d_MakeHyperbola const gp_Ax22d &  Axis,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius
 

Standard_EXPORT GCE2d_MakeHyperbola::GCE2d_MakeHyperbola const gp_Pnt2d &  S1,
const gp_Pnt2d &  S2,
const gp_Pnt2d &  Center
 


Member Function Documentation

Standard_EXPORT const Handle_Geom2d_Hyperbola& GCE2d_MakeHyperbola::Operator  )  const
 

void GCE2d_MakeHyperbola::operator delete void *  anAddress  )  [inline]
 

Reimplemented from GCE2d_Root.

Standard_EXPORT GCE2d_MakeHyperbola::operator Handle_Geom2d_Hyperbola  )  const
 

void* GCE2d_MakeHyperbola::operator new size_t  size  )  [inline]
 

Reimplemented from GCE2d_Root.

void* GCE2d_MakeHyperbola::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented from GCE2d_Root.

Standard_EXPORT const Handle_Geom2d_Hyperbola& GCE2d_MakeHyperbola::Value  )  const
 


Field Documentation

Handle_Geom2d_Hyperbola GCE2d_MakeHyperbola::TheHyperbola [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:22:42 2008 for OpenCASCADE by  doxygen 1.4.1