GeomAPI_Pln Class Reference

\Plane in 3D place, defined by normal, center and x-direction. More...

Inheritance diagram for GeomAPI_Pln:

Public Member Functions
GEOMAPI_EXPORT	GeomAPI_Pln (const std::shared_ptr< GeomAPI_Ax3 > &theAxes)
	Creation of plane by the axis placement. More...
GEOMAPI_EXPORT	GeomAPI_Pln (const std::shared_ptr< GeomAPI_Pnt > &thePoint, const std::shared_ptr< GeomAPI_Dir > &theNormal)
	Creation of plane by the point and normal. More...
GEOMAPI_EXPORT	GeomAPI_Pln (const double theA, const double theB, const double theC, const double theD)
	Creation of plane by coefficients (Ax+By+Cz+D=0) More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	location () const
	Returns a point of this plane. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir >	direction () const
	Returns a plane normal. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir >	xDirection () const
	Returns a plane x direction. More...
GEOMAPI_EXPORT void	coefficients (double &theA, double &theB, double &theC, double &theD)
	Returns the plane coefficients (Ax+By+Cz+D=0) More...
GEOMAPI_EXPORT bool	isCoincident (const std::shared_ptr< GeomAPI_Pln > thePlane, const double theTolerance=1.e-7)
	Returns true if planes are coincident. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	intersect (const std::shared_ptr< GeomAPI_Lin > &theLine) const
	Returns intersection point or empty if no intersections. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt >	project (const std::shared_ptr< GeomAPI_Pnt > &thePoint) const
	Returns projection of the given point onto the plane. More...
GEOMAPI_EXPORT double	distance (const std::shared_ptr< GeomAPI_Pln > thePlane) const
GEOMAPI_EXPORT double	distance (const std::shared_ptr< GeomAPI_Pnt > thePoint) const
GEOMAPI_EXPORT void	translate (const std::shared_ptr< GeomAPI_Dir > theDir, const double theDist)
	Translates the plane along direction theDir on distance theDist. More...
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Lin >	intersect (const std::shared_ptr< GeomAPI_Pln > thePlane) const
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

\Plane in 3D place, defined by normal, center and x-direction.

Constructor & Destructor Documentation

GeomAPI_Pln() [1/3]

GeomAPI_Pln::GeomAPI_Pln

(

const std::shared_ptr< GeomAPI_Ax3 > &

theAxes

)

Creation of plane by the axis placement.

GeomAPI_Pln() [2/3]

GeomAPI_Pln::GeomAPI_Pln	(	const std::shared_ptr< GeomAPI_Pnt > &	thePoint,
		const std::shared_ptr< GeomAPI_Dir > &	theNormal
	)

Creation of plane by the point and normal.

GeomAPI_Pln() [3/3]

GeomAPI_Pln::GeomAPI_Pln	(	const double	theA,
		const double	theB,
		const double	theC,
		const double	theD
	)

Creation of plane by coefficients (Ax+By+Cz+D=0)

Member Function Documentation

location()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Pln::location

(

)

const

Returns a point of this plane.

direction()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Pln::direction

(

)

const

Returns a plane normal.

xDirection()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Pln::xDirection

(

)

const

Returns a plane x direction.

coefficients()

void GeomAPI_Pln::coefficients	(	double &	theA,
		double &	theB,
		double &	theC,
		double &	theD
	)

Returns the plane coefficients (Ax+By+Cz+D=0)

isCoincident()

bool GeomAPI_Pln::isCoincident	(	const std::shared_ptr< GeomAPI_Pln >	thePlane,
		const double	theTolerance = 1.e-7
	)

Returns true if planes are coincident.

intersect() [1/2]

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Pln::intersect

(

const std::shared_ptr< GeomAPI_Lin > &

theLine

)

const

Returns intersection point or empty if no intersections.

project()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Pln::project

(

const std::shared_ptr< GeomAPI_Pnt > &

thePoint

)

const

Returns projection of the given point onto the plane.

distance() [1/2]

double GeomAPI_Pln::distance

(

const std::shared_ptr< GeomAPI_Pln >

thePlane

)

const

Returns

distance between planes.

distance() [2/2]

double GeomAPI_Pln::distance

(

const std::shared_ptr< GeomAPI_Pnt >

thePoint

)

const

Returns

distance from a point to this plane.

translate()

void GeomAPI_Pln::translate	(	const std::shared_ptr< GeomAPI_Dir >	theDir,
		const double	theDist
	)

Translates the plane along direction theDir on distance theDist.

intersect() [2/2]

std::shared_ptr< GeomAPI_Lin > GeomAPI_Pln::intersect

(

const std::shared_ptr< GeomAPI_Pln >

thePlane

)

const

Returns

intersection line of two planes. Empty if they are parallel.

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.