GeomAPI_Ellipse Class Reference

Ellipse in 3D. More...

#include <GeomAPI_Ellipse.h>

Inheritance diagram for GeomAPI_Ellipse:

Public Member Functions
GEOMAPI_EXPORT	GeomAPI_Ellipse ()
	Constructs an empty ellipse. More...
GEOMAPI_EXPORT	GeomAPI_Ellipse (const std::shared_ptr< GeomAPI_Ax2 > &theAx2, double theMajorRadius, double theMinorRadius)
	Constructs an ellipse with major and minor radiuses, where theAx2 locates the ellipse and defines its orientation in 3D space such that: . More...
GEOMAPI_EXPORT	GeomAPI_Ellipse (std::shared_ptr< GeomAPI_Curve > theCurve)
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	center () const
	Returns center of the ellipse. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	firstFocus () const
	Returns first focus of the ellipse. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	secondFocus () const
	Returns second focus of the ellipse. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir >	normal () const
	Return orthogonal direction to the ellipse's plane. More...
GEOMAPI_EXPORT double	minorRadius () const
	Returns minor radius of the ellipse. More...
GEOMAPI_EXPORT double	majorRadius () const
	Returns major radius of the ellipse. More...
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_Pnt >	project (const std::shared_ptr< GeomAPI_Pnt > &thePoint) const
	Project point on ellipse. 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 an ellipse. 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

Ellipse in 3D.

Constructor & Destructor Documentation

GeomAPI_Ellipse() [1/2]

GEOMAPI_EXPORT GeomAPI_Ellipse::GeomAPI_Ellipse ( )

inline

Constructs an empty ellipse.

GeomAPI_Ellipse() [2/2]

GeomAPI_Ellipse::GeomAPI_Ellipse	(	const std::shared_ptr< GeomAPI_Ax2 > &	theAx2,
		double	theMajorRadius,
		double	theMinorRadius
	)

Constructs an ellipse with major and minor radiuses, where theAx2 locates the ellipse 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.

Member Function Documentation

center()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Ellipse::center

(

)

const

Returns center of the ellipse.

firstFocus()

GeomPointPtr GeomAPI_Ellipse::firstFocus

(

)

const

Returns first focus of the ellipse.

secondFocus()

GeomPointPtr GeomAPI_Ellipse::secondFocus

(

)

const

Returns second focus of the ellipse.

normal()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Ellipse::normal

(

)

const

Return orthogonal direction to the ellipse's plane.

minorRadius()

double GeomAPI_Ellipse::minorRadius

(

)

const

Returns minor radius of the ellipse.

majorRadius()

double GeomAPI_Ellipse::majorRadius

(

)

const

Returns major radius of the ellipse.

project()

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

(

const std::shared_ptr< GeomAPI_Pnt > &

thePoint

)

const

Project point on ellipse.

parameter()

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

Computes the parameter of a given point on an ellipse.

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.