GC_MakeEllipse Class Reference

Implements construction algorithms for ellipses in 3D space. The result is a Geom_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 &theE)
	Creates an ellipse from a gp_Elips.
	GC_MakeEllipse (const gp_Ax2 &theA2, const double theMajorRadius, const double theMinorRadius)
	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 &theS1, const gp_Pnt &theS2, const gp_Pnt &theCenter)
	Constructs an ellipse centered on the point Center, where.
const occ::handle< Geom_Ellipse > &	Value () const
	Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.
	operator const occ::handle< Geom_Ellipse > & () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from GC_Root
bool	IsDone () const
	Returns true if the construction is successful.
bool	IsError () const
	Returns true if the construction has failed.
gce_ErrorType	Status () const
	Returns the status of the construction:

Additional Inherited Members
Protected Attributes inherited from GC_Root
gce_ErrorType	TheError

Detailed Description

Implements construction algorithms for ellipses in 3D space. The result is a Geom_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 &

theE

)

Creates an ellipse from a gp_Elips.

Parameters

[in]

theE

source ellipse

GC_MakeEllipse() [2/3]

GC_MakeEllipse::GC_MakeEllipse	(	const gp_Ax2 &	theA2,
		const double	theMajorRadius,
		const double	theMinorRadius )

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;

  Note

  Construction with theMajorRadius == theMinorRadius is allowed.

  Construction fails with gce_NegativeRadius if theMinorRadius < 0.0.

  Construction fails with gce_InvertAxis if theMajorRadius < theMinorRadius.

  Parameters

  [in]	theA2	ellipse local coordinate system
  [in]	theMajorRadius	major radius
  [in]	theMinorRadius	minor radius

GC_MakeEllipse() [3/3]

GC_MakeEllipse::GC_MakeEllipse	(	const gp_Pnt &	theS1,
		const gp_Pnt &	theS2,
		const gp_Pnt &	theCenter )

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.

  Parameters

  [in]	theS1	point defining the major axis
  [in]	theS2	point defining the minor radius
  [in]	theCenter	ellipse center

Member Function Documentation

operator const occ::handle< Geom_Ellipse > &()

GC_MakeEllipse::operator const occ::handle< Geom_Ellipse > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_Ellipse > & GC_MakeEllipse::Value

(

)

const

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

Returns

resulting ellipse

---

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

• GC_MakeEllipse.hxx