Open CASCADE Technology 7.8.0
Public Member Functions
gce_MakeElips Class Reference

This class implements the following algorithms used to create an ellipse from gp. More...

#include <gce_MakeElips.hxx>

Inheritance diagram for gce_MakeElips:
Inheritance graph
[legend]

Public Member Functions

 gce_MakeElips (const gp_Ax2 &A2, const Standard_Real MajorRadius, const Standard_Real MinorRadius)
 The major radius of the ellipse is on the "XAxis" and the minor radius is on the "YAxis" of the ellipse. The "XAxis" is defined with the "XDirection" of A2 and the "YAxis" is defined with the "YDirection" of A2. Warnings : It is not forbidden to create an ellipse with MajorRadius = MinorRadius.
 
 gce_MakeElips (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
 Make an ellipse with its center and two points. Warning The MakeElips class does not prevent the construction of an ellipse where the MajorRadius is equal to the MinorRadius. If an error occurs (that is, when IsDone returns false), the Status function returns:
 
const gp_ElipsValue () const
 Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.
 
const gp_ElipsOperator () const
 
 operator gp_Elips () const
 
- Public Member Functions inherited from gce_Root
Standard_Boolean IsDone () const
 Returns true if the construction is successful.
 
gce_ErrorType Status () const
 Returns the status of the construction:
 

Additional Inherited Members

- Protected Attributes inherited from gce_Root
gce_ErrorType TheError
 

Detailed Description

This class implements the following algorithms used to create an ellipse from gp.

Constructor & Destructor Documentation

◆ gce_MakeElips() [1/2]

gce_MakeElips::gce_MakeElips ( const gp_Ax2 A2,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius 
)

The major radius of the ellipse is on the "XAxis" and the minor radius is on the "YAxis" of the ellipse. The "XAxis" is defined with the "XDirection" of A2 and the "YAxis" is defined with the "YDirection" of A2. Warnings : It is not forbidden to create an ellipse with MajorRadius = MinorRadius.

◆ gce_MakeElips() [2/2]

gce_MakeElips::gce_MakeElips ( const gp_Pnt S1,
const gp_Pnt S2,
const gp_Pnt Center 
)

Make an ellipse with its center and two points. Warning The MakeElips class does not prevent the construction of an ellipse where the MajorRadius is equal to the MinorRadius. If an error occurs (that is, when IsDone returns false), the Status function returns:

  • gce_InvertRadius if MajorRadius is less than MinorRadius;
  • gce_NegativeRadius if MinorRadius is less than 0.0;
  • gce_NullAxis if the points S1 and Center are coincident; or
  • gce_InvertAxis if:
  • the major radius computed with Center and S1 is less than the minor radius computed with Center, S1 and S2, or
  • Center, S1 and S2 are collinear.

Member Function Documentation

◆ Operator()

const gp_Elips & gce_MakeElips::Operator ( ) const

◆ operator gp_Elips()

gce_MakeElips::operator gp_Elips ( ) const

◆ Value()

const gp_Elips & gce_MakeElips::Value ( ) const

Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.


The documentation for this class was generated from the following file: