SHAPER  9.12.0
GeomAPI_Ax3 Class Reference

The class represents a coordinate plane which is 2d plane with X and Y directions and origin. More...

Inheritance diagram for GeomAPI_Ax3:
Inheritance graph

Public Member Functions

 GeomAPI_Ax3 ()
 Default constructor. More...
 
 GeomAPI_Ax3 (std::shared_ptr< GeomAPI_Pnt > theOrigin, std::shared_ptr< GeomAPI_Dir > theDirX, std::shared_ptr< GeomAPI_Dir > theNorm)
 Constructor. More...
 
void setOrigin (const std::shared_ptr< GeomAPI_Pnt > &theOrigin)
 Sets origin point. More...
 
std::shared_ptr< GeomAPI_Pntorigin () const
 Returns the plane origin point. More...
 
void setDirX (const std::shared_ptr< GeomAPI_Dir > &theDirX)
 Sets X direction vector. More...
 
std::shared_ptr< GeomAPI_DirdirX () const
 Returns X direction vector. More...
 
void setDirY (const std::shared_ptr< GeomAPI_Dir > &theDirY)
 Sets Y direction vector. More...
 
std::shared_ptr< GeomAPI_DirdirY () const
 Returns Y direction vector. More...
 
void setNormal (const std::shared_ptr< GeomAPI_Dir > &theNorm)
 Sets Z direction vector. More...
 
std::shared_ptr< GeomAPI_Dirnormal () const
 Returns Z direction vector. More...
 
std::shared_ptr< GeomAPI_Pntto3D (double theX, double theY) const
 Converts 2d coordinates from the plane to 3d space point. More...
 
std::shared_ptr< GeomAPI_Pnt2dto2D (double theX, double theY, double theZ) const
 Converts 3d to 2d coordinates of the plane. 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

The class represents a coordinate plane which is 2d plane with X and Y directions and origin.

Constructor & Destructor Documentation

◆ GeomAPI_Ax3() [1/2]

GeomAPI_Ax3::GeomAPI_Ax3 ( )

Default constructor.

◆ GeomAPI_Ax3() [2/2]

GeomAPI_Ax3::GeomAPI_Ax3 ( std::shared_ptr< GeomAPI_Pnt theOrigin,
std::shared_ptr< GeomAPI_Dir theDirX,
std::shared_ptr< GeomAPI_Dir theNorm 
)

Constructor.

Parameters
theOriginpoint of origin
theDirXdirection of X axis
theNormdirection of normal vector

Member Function Documentation

◆ setOrigin()

void GeomAPI_Ax3::setOrigin ( const std::shared_ptr< GeomAPI_Pnt > &  theOrigin)

Sets origin point.

◆ origin()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Ax3::origin ( ) const

Returns the plane origin point.

◆ setDirX()

void GeomAPI_Ax3::setDirX ( const std::shared_ptr< GeomAPI_Dir > &  theDirX)

Sets X direction vector.

◆ dirX()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Ax3::dirX ( ) const

Returns X direction vector.

◆ setDirY()

void GeomAPI_Ax3::setDirY ( const std::shared_ptr< GeomAPI_Dir > &  theDirY)

Sets Y direction vector.

◆ dirY()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Ax3::dirY ( ) const

Returns Y direction vector.

◆ setNormal()

void GeomAPI_Ax3::setNormal ( const std::shared_ptr< GeomAPI_Dir > &  theNorm)

Sets Z direction vector.

◆ normal()

std::shared_ptr< GeomAPI_Dir > GeomAPI_Ax3::normal ( ) const

Returns Z direction vector.

◆ to3D()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Ax3::to3D ( double  theX,
double  theY 
) const

Converts 2d coordinates from the plane to 3d space point.

Parameters
theXX coordinate
theYY coordinate

◆ to2D()

std::shared_ptr< GeomAPI_Pnt2d > GeomAPI_Ax3::to2D ( double  theX,
double  theY,
double  theZ 
) const

Converts 3d to 2d coordinates of the plane.

Parameters
theXX coordinate
theYY coordinate
theZZ coordinate

◆ 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.