gce_MakeElips Class Reference

This class implements construction algorithms for gp_Elips. Supported constructions include: More...

#include <gce_MakeElips.hxx>

Inheritance diagram for gce_MakeElips:

Public Member Functions
	gce_MakeElips (const gp_Ax2 &A2, const double MajorRadius, const double 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.
	gce_MakeElips (const gp_Pnt &S1, const gp_Pnt &S2, const gp_Pnt &Center)
	Creates an ellipse from center and two points.
const gp_Elips &	Value () const
	Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.
gp_Elips	Operator () const
	Alias for Value() returning a copy.
	operator gp_Elips () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from gce_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 gce_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for gp_Elips. Supported constructions include:

• ellipse from local coordinate system and radii;
• ellipse from center and two points.

Constructor & Destructor Documentation

gce_MakeElips() [1/2]

gce_MakeElips::gce_MakeElips	(	const gp_Ax2 &	A2,
		const double	MajorRadius,
		const double	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.

Note

It is possible to create an ellipse with MajorRadius == MinorRadius.

Construction fails with gce_InvertRadius if MajorRadius < MinorRadius.

Construction fails with gce_NegativeRadius if MinorRadius < 0.0.

Parameters

[in]	A2	local coordinate system
[in]	MajorRadius	major radius value
[in]	MinorRadius	minor radius value

gce_MakeElips() [2/2]

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

Creates an ellipse from center and two points.

Note

S1 defines major radius direction and value.

Minor radius is computed as distance from S2 to major axis.

Construction fails with gce_NullAxis if S1 and Center coincide.

Construction fails with gce_InvertAxis when computed minor radius is null/greater than major radius, or when points are collinear.

Parameters

[in]	S1	first point
[in]	S2	second point
[in]	Center	center point

Member Function Documentation

Operator()

gp_Elips gce_MakeElips::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Elips()

gce_MakeElips::operator gp_Elips ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Elips & gce_MakeElips::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:

• gce_MakeElips.hxx