gce_MakeCirc2d Class Reference

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

#include <gce_MakeCirc2d.hxx>

Inheritance diagram for gce_MakeCirc2d:

Public Member Functions
	gce_MakeCirc2d (const gp_Ax2d &XAxis, const double Radius, const bool Sense=true)
	Creates a circle from axis and radius.
	gce_MakeCirc2d (const gp_Ax22d &Axis, const double Radius)
	Creates a circle from local coordinate system and radius.
	gce_MakeCirc2d (const gp_Circ2d &Circ, const double Dist)
	Creates a circle concentric to input circle with signed offset.
	gce_MakeCirc2d (const gp_Circ2d &Circ, const gp_Pnt2d &Point)
	Creates a circle concentric to input circle and passing through a point.
	gce_MakeCirc2d (const gp_Pnt2d &P1, const gp_Pnt2d &P2, const gp_Pnt2d &P3)
	Creates a circle passing through three points.
	gce_MakeCirc2d (const gp_Pnt2d &Center, const double Radius, const bool Sense=true)
	Creates a circle from center and radius.
	gce_MakeCirc2d (const gp_Pnt2d &Center, const gp_Pnt2d &Point, const bool Sense=true)
	Creates a circle from center and one point on circle.
const gp_Circ2d &	Value () const
	Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.
gp_Circ2d	Operator () const
	Alias for Value() returning a copy.
	operator gp_Circ2d () 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_Circ2d. Supported constructions include:

• circle from axis and radius;
• circle concentric to another one, through point or at signed offset;
• circle through three points;
• circle from center and radius;
• circle from center and one point.

Constructor & Destructor Documentation

gce_MakeCirc2d() [1/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Ax2d &	XAxis,
		const double	Radius,
		const bool	Sense = true )

Creates a circle from axis and radius.

Note

The location of XAxis is the circle center.

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

[in]	XAxis	axis placement
[in]	Radius	radius value
[in]	Sense	orientation flag

gce_MakeCirc2d() [2/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Ax22d &	Axis,
		const double	Radius )

Creates a circle from local coordinate system and radius.

Note

The location of Axis is the circle center.

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

[in]	Axis	axis definition
[in]	Radius	radius value

gce_MakeCirc2d() [3/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Circ2d &	Circ,
		const double	Dist )

Creates a circle concentric to input circle with signed offset.

Note

Result radius is Abs(Circ.Radius() + Dist).

Parameters

[in]	Circ	source circle
[in]	Dist	signed distance

gce_MakeCirc2d() [4/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Circ2d &	Circ,
		const gp_Pnt2d &	Point )

Creates a circle concentric to input circle and passing through a point.

Parameters

[in]	Circ	source circle
[in]	Point	reference point

gce_MakeCirc2d() [5/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Pnt2d &	P1,
		const gp_Pnt2d &	P2,
		const gp_Pnt2d &	P3 )

Creates a circle passing through three points.

Note

The local coordinate system of the result is derived from input points.

Parameters

[in]	P1	first point
[in]	P2	second point
[in]	P3	third point

gce_MakeCirc2d() [6/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Pnt2d &	Center,
		const double	Radius,
		const bool	Sense = true )

Creates a circle from center and radius.

Note

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

[in]	Center	center point
[in]	Radius	radius value
[in]	Sense	orientation flag

gce_MakeCirc2d() [7/7]

gce_MakeCirc2d::gce_MakeCirc2d	(	const gp_Pnt2d &	Center,
		const gp_Pnt2d &	Point,
		const bool	Sense = true )

Creates a circle from center and one point on circle.

Note

Sense controls result orientation.

Parameters

[in]	Center	center point
[in]	Point	reference point
[in]	Sense	orientation flag

Member Function Documentation

Operator()

gp_Circ2d gce_MakeCirc2d::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Circ2d()

gce_MakeCirc2d::operator gp_Circ2d ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Circ2d & gce_MakeCirc2d::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:

• gce_MakeCirc2d.hxx