GC_MakeEllipse2d Class Reference

This class implements construction algorithms for ellipses in the plane. The result is a Geom2d_Ellipse. A GC_MakeEllipse2d object provides a framework for: More...

#include <GC_MakeEllipse2d.hxx>

Inheritance diagram for GC_MakeEllipse2d:

Public Member Functions
	GC_MakeEllipse2d (const gp_Elips2d &theEllipse)
	Creates an ellipse from a non-persistent one from package gp.
	GC_MakeEllipse2d (const gp_Ax2d &theMajorAxis, const double theMajorRadius, const double theMinorRadius, const bool theSense=true)
	Creates an ellipse from major axis placement and radii.
	GC_MakeEllipse2d (const gp_Ax22d &theAxis, const double theMajorRadius, const double theMinorRadius)
	Creates an ellipse from a local coordinate system and radii.
	GC_MakeEllipse2d (const gp_Pnt2d &theS1, const gp_Pnt2d &theS2, const gp_Pnt2d &theCenter)
	Creates an ellipse from two apex points and center point.
const occ::handle< Geom2d_Ellipse > &	Value () const
	Returns the constructed ellipse. Exceptions StdFail_NotDone if no ellipse is constructed.
	operator const occ::handle< Geom2d_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

This class implements construction algorithms for ellipses in the plane. The result is a Geom2d_Ellipse. A GC_MakeEllipse2d object provides a framework for:

• defining the construction parameters;
• running the construction algorithm;
• querying the construction status and the resulting ellipse via Value().

  Note

  Ellipse parameterization range is [0, 2*PI].

  The X axis of the local coordinate system is the major axis, and the Y axis is the minor axis.

Constructor & Destructor Documentation

GC_MakeEllipse2d() [1/4]

GC_MakeEllipse2d::GC_MakeEllipse2d

(

const gp_Elips2d &

theEllipse

)

Creates an ellipse from a non-persistent one from package gp.

Parameters

[in]

theEllipse

source ellipse

GC_MakeEllipse2d() [2/4]

GC_MakeEllipse2d::GC_MakeEllipse2d	(	const gp_Ax2d &	theMajorAxis,
		const double	theMajorRadius,
		const double	theMinorRadius,
		const bool	theSense = true )

Creates an ellipse from major axis placement and radii.

Parameters

[in]	theMajorAxis	major axis placement
[in]	theMajorRadius	major radius value
[in]	theMinorRadius	minor radius value
[in]	theSense	orientation flag

Note

Error status is provided by the underlying gce_MakeElips2d (for example gce_InvertRadius or gce_NegativeRadius).

GC_MakeEllipse2d() [3/4]

GC_MakeEllipse2d::GC_MakeEllipse2d	(	const gp_Ax22d &	theAxis,
		const double	theMajorRadius,
		const double	theMinorRadius )

Creates an ellipse from a local coordinate system and radii.

Parameters

[in]	theAxis	local coordinate system
[in]	theMajorRadius	major radius value
[in]	theMinorRadius	minor radius value

Note

Error status is provided by the underlying gce_MakeElips2d (for example gce_InvertRadius or gce_NegativeRadius).

GC_MakeEllipse2d() [4/4]

GC_MakeEllipse2d::GC_MakeEllipse2d	(	const gp_Pnt2d &	theS1,
		const gp_Pnt2d &	theS2,
		const gp_Pnt2d &	theCenter )

Creates an ellipse from two apex points and center point.

Parameters

[in]	theS1	first apex point
[in]	theS2	second point defining minor radius
[in]	theCenter	center point

Note

Error status is provided by the underlying gce_MakeElips2d.

Member Function Documentation

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

GC_MakeEllipse2d::operator const occ::handle< Geom2d_Ellipse > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting ellipse

Value()

const occ::handle< Geom2d_Ellipse > & GC_MakeEllipse2d::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_MakeEllipse2d.hxx