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

ModelingData
TKGeomBase
gce


gce_MakeHypr Class Reference

This class implements the following algorithms used to
create Hyperbola from gp.
* Create an Hyperbola from its center, and two points:
one on its axis of symmetry giving the major radius, the
other giving the value of the small radius.
The three points give the plane of the hyperbola.
* Create an hyperbola from its axisplacement and its
MajorRadius and its MinorRadius.


^YAxis
|
FirstConjugateBranch
|
Other | Main
--------------------- C ------------------------------>XAxis
Branch | Branch
|
|
SecondConjugateBranch
|
.

#include <gce_MakeHypr.hxx>

Inheritance diagram for gce_MakeHypr:

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 gce_MakeHypr (const gp_Ax2 &A2, const Standard_Real MajorRadius, const Standard_Real MinorRadius)
 A2 is the local coordinate system of the hyperbola.
In the local coordinates system A2 the equation of the
hyperbola is :
X*X / MajorRadius*MajorRadius - Y*Y / MinorRadius*MinorRadius = 1.0
It is not forbidden to create an Hyperbola with MajorRadius =
MinorRadius.
For the hyperbola the MajorRadius can be lower than the
MinorRadius.
The status is "NegativeRadius" if MajorRadius < 0.0 and
"InvertRadius" if MinorRadius > MajorRadius.
.
Standard_EXPORT gce_MakeHypr (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
 Constructs a hyperbola
- centered on the point Center, where:
- the plane of the hyperbola is defined by Center, S1 and S2,
- its major axis is defined by Center and S1,
- its major radius is the distance between Center and S1, and
- its minor radius is the distance between S2 and the major axis.
Warning
If an error occurs (that is, when IsDone returns
false), the Status function returns:
- gce_NegativeRadius if MajorRadius is less than 0.0;
- gce_InvertRadius if:
- the major radius (computed with Center, S1) is
less than the minor radius (computed with Center, S1 and S2), or
- MajorRadius is less than MinorRadius; or
- gce_ColinearPoints if S1, S2 and Center are collinear.
.
Standard_EXPORT const gp_Hypr & Value () const
 Returns the constructed hyperbola.
Exceptions StdFail_NotDone if no hyperbola is constructed.
.
Standard_EXPORT const gp_Hypr & Operator () const
Standard_EXPORT operator gp_Hypr () const

Private Attributes

gp_Hypr TheHypr

Constructor & Destructor Documentation

Standard_EXPORT gce_MakeHypr::gce_MakeHypr const gp_Ax2 &  A2,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius
 

Standard_EXPORT gce_MakeHypr::gce_MakeHypr const gp_Pnt &  S1,
const gp_Pnt &  S2,
const gp_Pnt &  Center
 


Member Function Documentation

Standard_EXPORT const gp_Hypr& gce_MakeHypr::Operator  )  const
 

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

Reimplemented from gce_Root.

Standard_EXPORT gce_MakeHypr::operator gp_Hypr  )  const
 

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

Reimplemented from gce_Root.

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

Reimplemented from gce_Root.

Standard_EXPORT const gp_Hypr& gce_MakeHypr::Value  )  const
 


Field Documentation

gp_Hypr gce_MakeHypr::TheHypr [private]
 


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