GC_MakeCircle Class Reference

Implements construction algorithms for circles in 3D space. More...

#include <GC_MakeCircle.hxx>

Inheritance diagram for GC_MakeCircle:

Public Member Functions
	GC_MakeCircle (const gp_Circ &theC)
	Creates a circle from a gp_Circ.
	GC_MakeCircle (const gp_Ax2 &theA2, const double theRadius)
	Creates a circle from axis placement and radius.
	GC_MakeCircle (const gp_Circ &theCirc, const double theDist)
	Creates a circle concentric to the input circle with an offset radius.
	GC_MakeCircle (const gp_Circ &theCirc, const gp_Pnt &thePoint)
	Creates a circle concentric to the input circle and passing through the input point.
	GC_MakeCircle (const gp_Pnt &theP1, const gp_Pnt &theP2, const gp_Pnt &theP3)
	Creates a circle passing through three points.
	GC_MakeCircle (const gp_Pnt &theCenter, const gp_Dir &theNorm, const double theRadius)
	Creates a circle from center point, normal and radius.
	GC_MakeCircle (const gp_Pnt &theCenter, const gp_Pnt &thePtAxis, const double theRadius)
	Creates a circle from center point, axis point and radius.
	GC_MakeCircle (const gp_Ax1 &theAxis, const double theRadius)
	Creates a circle from axis and radius.
const occ::handle< Geom_Circle > &	Value () const
	Returns the constructed circle. Exceptions StdFail_NotDone if no circle is constructed.
	operator const occ::handle< Geom_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

Implements construction algorithms for circles in 3D space.

• Create a circle parallel to another and passing through a point.
• Create a Circle parallel to another at the distance Dist.
• Create a Circle passing through 3 points.
• Create a Circle with its center and the normal of its plane and its radius.
• Create a Circle with its axis and radius. The circle parameter is the angle in radians. The parametrization range is [0,2*PI]. The circle is a closed and periodic curve. The center of the circle is the Location point of its axis placement. The XDirection of the axis placement defines the origin of the parametrization.

Constructor & Destructor Documentation

GC_MakeCircle() [1/8]

GC_MakeCircle::GC_MakeCircle

(

const gp_Circ &

theC

)

Creates a circle from a gp_Circ.

Parameters

[in]

theC

source circle

GC_MakeCircle() [2/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Ax2 &	theA2,
		const double	theRadius )

Creates a circle from axis placement and radius.

Parameters

[in]	theA2	local coordinate system of the circle
[in]	theRadius	circle radius

Note

Radius equal to 0.0 is allowed.

The status is gce_NegativeRadius if theRadius < 0.0.

GC_MakeCircle() [3/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Circ &	theCirc,
		const double	theDist )

Creates a circle concentric to the input circle with an offset radius.

Parameters

[in]	theCirc	reference circle
[in]	theDist	radius offset

GC_MakeCircle() [4/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Circ &	theCirc,
		const gp_Pnt &	thePoint )

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

Parameters

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

GC_MakeCircle() [5/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const gp_Pnt &	theP3 )

Creates a circle passing through three points.

Parameters

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

GC_MakeCircle() [6/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Pnt &	theCenter,
		const gp_Dir &	theNorm,
		const double	theRadius )

Creates a circle from center point, normal and radius.

Parameters

[in]	theCenter	circle center
[in]	theNorm	normal direction of circle plane
[in]	theRadius	circle radius

GC_MakeCircle() [7/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Pnt &	theCenter,
		const gp_Pnt &	thePtAxis,
		const double	theRadius )

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

Parameters

[in]	theCenter	circle center
[in]	thePtAxis	point defining normal direction
[in]	theRadius	circle radius

Note

The direction is defined by vector (theCenter,thePtAxis).

GC_MakeCircle() [8/8]

GC_MakeCircle::GC_MakeCircle	(	const gp_Ax1 &	theAxis,
		const double	theRadius )

Creates a circle from axis and radius.

Parameters

[in]	theAxis	circle axis
[in]	theRadius	circle radius

Member Function Documentation

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

GC_MakeCircle::operator const occ::handle< Geom_Circle > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_Circle > & GC_MakeCircle::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_MakeCircle.hxx