gce_MakeCirc Class Reference

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

#include <gce_MakeCirc.hxx>

Inheritance diagram for gce_MakeCirc:

Public Member Functions
	gce_MakeCirc (const gp_Ax2 &A2, const double Radius)
	Creates a circle from axis placement and radius.
	gce_MakeCirc (const gp_Circ &Circ, const double Dist)
	Creates a circle coaxial to input circle at signed distance.
	gce_MakeCirc (const gp_Circ &Circ, const gp_Pnt &Point)
	Creates a circle coaxial to input circle and passing through a point.
	gce_MakeCirc (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
	Creates a circle passing through three points.
	gce_MakeCirc (const gp_Pnt &Center, const gp_Dir &Norm, const double Radius)
	Creates a circle from center, plane normal and radius.
	gce_MakeCirc (const gp_Pnt &Center, const gp_Pln &Plane, const double Radius)
	Creates a circle from center, reference plane and radius.
	gce_MakeCirc (const gp_Pnt &Center, const gp_Pnt &Ptaxis, const double Radius)
	Creates a circle from center, axis-defining point and radius.
	gce_MakeCirc (const gp_Ax1 &Axis, const double Radius)
	Creates a circle from axis and radius.
const gp_Circ &	Value () const
	Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.
gp_Circ	Operator () const
	Alias for Value() returning a copy.
	operator gp_Circ () 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_Circ. Supported constructions include:

• circle from axis and radius;
• circle coaxial to another one, through point or at signed offset;
• circle through three points;
• circle from center and normal/plane;
• circle from center and axis-defining point;
• circle from axis and radius.

Constructor & Destructor Documentation

gce_MakeCirc() [1/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Ax2 &	A2,
		const double	Radius )

Creates a circle from axis placement and radius.

Note

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

[in]	A2	local coordinate system
[in]	Radius	radius value

gce_MakeCirc() [2/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Circ &	Circ,
		const double	Dist )

Creates a circle coaxial to input circle at signed distance.

Note

If Dist is positive, the result encloses Circ.

If Dist is negative, the result is enclosed by Circ.

Parameters

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

gce_MakeCirc() [3/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Circ &	Circ,
		const gp_Pnt &	Point )

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

Parameters

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

gce_MakeCirc() [4/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2,
		const gp_Pnt &	P3 )

Creates a circle passing through three points.

Parameters

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

gce_MakeCirc() [5/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Pnt &	Center,
		const gp_Dir &	Norm,
		const double	Radius )

Creates a circle from center, plane normal and radius.

Parameters

[in]	Center	center point
[in]	Norm	input value
[in]	Radius	radius value

gce_MakeCirc() [6/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Pnt &	Center,
		const gp_Pln &	Plane,
		const double	Radius )

Creates a circle from center, reference plane and radius.

Parameters

[in]	Center	center point
[in]	Plane	reference plane
[in]	Radius	radius value

gce_MakeCirc() [7/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Pnt &	Center,
		const gp_Pnt &	Ptaxis,
		const double	Radius )

Creates a circle from center, axis-defining point and radius.

Parameters

[in]	Center	center point
[in]	Ptaxis	point defining axis direction
[in]	Radius	radius value

gce_MakeCirc() [8/8]

gce_MakeCirc::gce_MakeCirc	(	const gp_Ax1 &	Axis,
		const double	Radius )

Creates a circle from axis and radius.

Note

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

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

Member Function Documentation

Operator()

gp_Circ gce_MakeCirc::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Circ()

gce_MakeCirc::operator gp_Circ ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Circ & gce_MakeCirc::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_MakeCirc.hxx