GC_MakeEllipse Class Reference

This class implements construction algorithms for an ellipse in 3D space. The result is a Geom_Ellipse ellipse. A MakeEllipse object provides a framework for: More...

#include <GC_MakeEllipse.hxx>

Inheritance diagram for GC_MakeEllipse:

Public Member Functions
	GC_MakeEllipse (const gp_Elips &E)
	Creates an ellipse from a non persistent ellipse E from package gp by its conversion.
	GC_MakeEllipse (const gp_Ax2 &A2, const Standard_Real MajorRadius, const Standard_Real MinorRadius)
	Constructs an ellipse with major and minor radii MajorRadius and MinorRadius, and located in the plane defined by the "X Axis" and "Y Axis" of the coordinate system A2, where:
	GC_MakeEllipse (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
	Constructs an ellipse centered on the point Center, where.
const Handle< Geom_Ellipse > &	Value () const
	Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.
	operator const Handle< Geom_Ellipse > & () const
Public Member Functions inherited from GC_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 GC_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for an ellipse in 3D space. The result is a Geom_Ellipse ellipse. A MakeEllipse object provides a framework for:

• defining the construction of the ellipse,
• implementing the construction algorithm, and
• consulting the results. In particular, the Value function returns the constructed ellipse.

Constructor & Destructor Documentation

GC_MakeEllipse() [1/3]

GC_MakeEllipse::GC_MakeEllipse

(

const gp_Elips &

E

)

Creates an ellipse from a non persistent ellipse E from package gp by its conversion.

GC_MakeEllipse() [2/3]

GC_MakeEllipse::GC_MakeEllipse	(	const gp_Ax2 &	A2,
		const Standard_Real	MajorRadius,
		const Standard_Real	MinorRadius
	)

Constructs an ellipse with major and minor radii MajorRadius and MinorRadius, and located in the plane defined by the "X Axis" and "Y Axis" of the coordinate system A2, where:

• its center is the origin of A2, and
• its major axis is the "X Axis" of A2; Warnings : The MakeEllipse class does not prevent the construction of an ellipse where MajorRadius is equal to 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.

GC_MakeEllipse() [3/3]

GC_MakeEllipse::GC_MakeEllipse	(	const gp_Pnt &	S1,
		const gp_Pnt &	S2,
		const gp_Pnt &	Center
	)

Constructs an ellipse centered on the point Center, where.

• the plane of the ellipse 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.

Member Function Documentation

operator const Handle< Geom_Ellipse > &()

GC_MakeEllipse::operator const Handle< Geom_Ellipse > & ( ) const

inline

Value()

const Handle< Geom_Ellipse > & GC_MakeEllipse::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:

• GC_MakeEllipse.hxx