GC_MakeCircle2d Class Reference

This class implements construction algorithms for circles in the plane. The result is a Geom2d_Circle. A GC_MakeCircle2d object provides a framework for: More...

#include <GC_MakeCircle2d.hxx>

Inheritance diagram for GC_MakeCircle2d:

Public Member Functions
	GC_MakeCircle2d (const gp_Circ2d &theCircle)
	Creates a circle from a non-persistent one from package gp.
	GC_MakeCircle2d (const gp_Ax2d &theAxis, const double theRadius, const bool theSense=true)
	Creates a circle from an axis placement and radius.
	GC_MakeCircle2d (const gp_Ax22d &theAxis, const double theRadius)
	Creates a circle from a local coordinate system and radius.
	GC_MakeCircle2d (const gp_Circ2d &theCircle, const double theDist)
	Creates a circle parallel to another one at signed distance.
	GC_MakeCircle2d (const gp_Circ2d &theCircle, const gp_Pnt2d &thePoint)
	Creates a circle parallel to another one and passing through a point.
	GC_MakeCircle2d (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2, const gp_Pnt2d &theP3)
	Creates a circle passing through three points.
	GC_MakeCircle2d (const gp_Pnt2d &theCenter, const double theRadius, const bool theSense=true)
	Creates a circle from center point and radius.
	GC_MakeCircle2d (const gp_Pnt2d &theCenter, const gp_Pnt2d &thePoint, const bool theSense=true)
	Creates a circle from center point and one point on the circle.
const occ::handle< Geom2d_Circle > &	Value () const
	Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.
	operator const occ::handle< Geom2d_Circle > & () 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 circles in the plane. The result is a Geom2d_Circle. A GC_MakeCircle2d object provides a framework for:

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

  Note

  A circle is parameterized in the range [0, 2*PI], and the X axis of its local coordinate system defines the parameter origin.

Constructor & Destructor Documentation

GC_MakeCircle2d() [1/8]

GC_MakeCircle2d::GC_MakeCircle2d

(

const gp_Circ2d &

theCircle

)

Creates a circle from a non-persistent one from package gp.

Parameters

[in]

theCircle

source circle

GC_MakeCircle2d() [2/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Ax2d &	theAxis,
		const double	theRadius,
		const bool	theSense = true )

Creates a circle from an axis placement and radius.

Parameters

[in]	theAxis	axis placement
[in]	theRadius	radius value
[in]	theSense	orientation flag

Note

Construction fails with gce_NegativeRadius if theRadius is negative.

GC_MakeCircle2d() [3/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Ax22d &	theAxis,
		const double	theRadius )

Creates a circle from a local coordinate system and radius.

Parameters

[in]	theAxis	local coordinate system
[in]	theRadius	radius value

Note

Construction fails with gce_NegativeRadius if theRadius is negative.

GC_MakeCircle2d() [4/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Circ2d &	theCircle,
		const double	theDist )

Creates a circle parallel to another one at signed distance.

Parameters

[in]	theCircle	source circle
[in]	theDist	signed distance

Note

If theDist is positive, the resulting circle encloses theCircle.

If theDist is negative, the resulting circle is enclosed by theCircle.

Error status is provided by the underlying gce_MakeCirc2d.

GC_MakeCircle2d() [5/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Circ2d &	theCircle,
		const gp_Pnt2d &	thePoint )

Creates a circle parallel to another one and passing through a point.

Parameters

[in]	theCircle	source circle
[in]	thePoint	point on resulting circle

Note

Error status is provided by the underlying gce_MakeCirc2d.

GC_MakeCircle2d() [6/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Pnt2d &	theP1,
		const gp_Pnt2d &	theP2,
		const gp_Pnt2d &	theP3 )

Creates a circle passing through three points.

Parameters

[in]	theP1	first point
[in]	theP2	second point
[in]	theP3	third point

Note

Error status is provided by the underlying gce_MakeCirc2d.

GC_MakeCircle2d() [7/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Pnt2d &	theCenter,
		const double	theRadius,
		const bool	theSense = true )

Creates a circle from center point and radius.

Parameters

[in]	theCenter	center point
[in]	theRadius	radius value
[in]	theSense	orientation flag

Note

Error status is provided by the underlying gce_MakeCirc2d.

GC_MakeCircle2d() [8/8]

GC_MakeCircle2d::GC_MakeCircle2d	(	const gp_Pnt2d &	theCenter,
		const gp_Pnt2d &	thePoint,
		const bool	theSense = true )

Creates a circle from center point and one point on the circle.

Parameters

[in]	theCenter	center point
[in]	thePoint	point on resulting circle
[in]	theSense	orientation flag

Note

Error status is provided by the underlying gce_MakeCirc2d.

Member Function Documentation

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

GC_MakeCircle2d::operator const occ::handle< Geom2d_Circle > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting circle

Value()

const occ::handle< Geom2d_Circle > & GC_MakeCircle2d::Value

(

)

const

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

Returns

resulting circle

---

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

• GC_MakeCircle2d.hxx