GeomAPI_Circ Class Reference

Circle in 3D. More...

#include <GeomAPI_Circ.h>

Inheritance diagram for GeomAPI_Circ:

Public Member Functions
GEOMAPI_EXPORT	GeomAPI_Circ (const std::shared_ptr< GeomAPI_Ax2 > theAx2, const double theRadius)
	Constructs a circle of radius Radius, where theAx2 locates the circle and defines its orientation in 3D space such that: . More...
GEOMAPI_EXPORT	GeomAPI_Circ (const std::shared_ptr< GeomAPI_Pnt > &theCenter, const std::shared_ptr< GeomAPI_Dir > &theDir, double theRadius)
	Creation of circle defined by center point, direction and circle radius. More...
GEOMAPI_EXPORT	GeomAPI_Circ (const GeomCurvePtr &theCurve)
	Creation of circle defined by a curve. More...
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_Pnt >	center () const
	Return center of the circle. More...
GEOMAPI_EXPORT double	radius () const
	Return radius of the circle. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir >	normal () const
	Return orthogonal direction to the circle's plane. More...
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_Pnt >	project (const std::shared_ptr< GeomAPI_Pnt > &thePoint) const
	Project point on circle. More...
GEOMAPI_EXPORT const bool	parameter (const std::shared_ptr< GeomAPI_Pnt > thePoint, const double theTolerance, double &theParameter) const
	Computes the parameter of a given point on a circle. More...
template<class T >
T *	implPtr ()
	Returns the pointer to the impl. More...
template<class T >
const T *	implPtr () const
	Returns the pointer to the impl. More...
template<class T >
const T &	impl () const
	Returns the reference object of the impl. More...
template<class T >
void	setImpl (T *theImpl)
	Updates the impl (deletes the old one) More...
GEOMAPI_EXPORT bool	empty () const
	Returns true if the impl is empty. More...

Detailed Description

Circle in 3D.

Constructor & Destructor Documentation

GeomAPI_Circ() [1/3]

GeomAPI_Circ::GeomAPI_Circ	(	const std::shared_ptr< GeomAPI_Ax2 >	theAx2,
		const double	theRadius
	)

Constructs a circle of radius Radius, where theAx2 locates the circle and defines its orientation in 3D space such that:
.

• the center of the circle is the origin of theAx2;
  
• the origin, "X Direction" and "Y Direction" of theAx2 define the plane of the circle;
  
• theAx2 is the local coordinate system of the circle.
  Note: It is possible to create a circle where Radius is equal to 0.0. raised if Radius < 0.

GeomAPI_Circ() [2/3]

GeomAPI_Circ::GeomAPI_Circ	(	const std::shared_ptr< GeomAPI_Pnt > &	theCenter,
		const std::shared_ptr< GeomAPI_Dir > &	theDir,
		double	theRadius
	)

Creation of circle defined by center point, direction and circle radius.

GeomAPI_Circ() [3/3]

GeomAPI_Circ::GeomAPI_Circ

(

const GeomCurvePtr &

theCurve

)

Creation of circle defined by a curve.

Member Function Documentation

center()

const std::shared_ptr< GeomAPI_Pnt > GeomAPI_Circ::center

(

)

const

Return center of the circle.

radius()

double GeomAPI_Circ::radius

(

)

const

Return radius of the circle.

normal()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Circ::normal

(

)

const

Return orthogonal direction to the circle's plane.

project()

const std::shared_ptr< GeomAPI_Pnt > GeomAPI_Circ::project

(

const std::shared_ptr< GeomAPI_Pnt > &

thePoint

)

const

Project point on circle.

parameter()

const bool GeomAPI_Circ::parameter	(	const std::shared_ptr< GeomAPI_Pnt >	thePoint,
		const double	theTolerance,
		double &	theParameter
	)		const

Computes the parameter of a given point on a circle.

The point must be located either on the circle itself or relatively to the latter at a distance less than the tolerance value. Return FALSE if the point is beyond the tolerance limit or if computation fails. Max Tolerance value is currently limited to 1.e-4

Parameters

[in]	thePoint	point of origin.
[in]	theTolerance	tolerance of computation.
[out]	theParameter	resulting parameter.

implPtr() [1/2]

template<class T >

T * GeomAPI_Interface::implPtr ( )

inlineinherited

Returns the pointer to the impl.

implPtr() [2/2]

template<class T >

const T * GeomAPI_Interface::implPtr ( ) const

inlineinherited

Returns the pointer to the impl.

impl()

template<class T >

const T & GeomAPI_Interface::impl ( ) const

inlineinherited

Returns the reference object of the impl.

setImpl()

template<class T >

void GeomAPI_Interface::setImpl ( T *  theImpl )

inlineinherited

Updates the impl (deletes the old one)

empty()

bool GeomAPI_Interface::empty ( ) const

inherited

Returns true if the impl is empty.