SHAPER  9.12.0
GeomAPI_Curve Class Reference

Interface to the generic curve object. More...

Inheritance diagram for GeomAPI_Curve:
Inheritance graph

Data Structures

class  Comparator
 Compare addresses of curves. More...
 

Public Member Functions

GEOMAPI_EXPORT GeomAPI_Curve ()
 Creation of empty (null) shape. More...
 
GEOMAPI_EXPORT GeomAPI_Curve (const std::shared_ptr< GeomAPI_Shape > &theShape)
 Creates a curve from the shape (edge) More...
 
GEOMAPI_EXPORT bool isNull () const
 Returns true if curve is not initialized. More...
 
GEOMAPI_EXPORT bool isEqual (const std::shared_ptr< GeomAPI_Curve > &theOther) const
 Returns true if curves are equal. More...
 
virtual GEOMAPI_EXPORT bool isLine () const
 Returns whether the curve is linear. More...
 
virtual GEOMAPI_EXPORT bool isCircle () const
 Returns whether the curve is circular. More...
 
virtual GEOMAPI_EXPORT bool isEllipse () const
 Returns whether the curve is elliptic. More...
 
GEOMAPI_EXPORT double startParam ()
 Returns start parameter of the curve. More...
 
GEOMAPI_EXPORT double endParam ()
 Returns end parameter of the curve. More...
 
virtual GEOMAPI_EXPORT bool isTrimmed () const
 Returns true if the curve is trimmed. More...
 
virtual GEOMAPI_EXPORT std::shared_ptr< GeomAPI_CurvebasisCurve () const
 Returns basis for the trimmed curve. More...
 
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_PntgetPoint (double theParam)
 Returns point on the curve by parameter. More...
 
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_Pntproject (const std::shared_ptr< GeomAPI_Pnt > &thePoint) const
 Project point on curve. 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

Interface to the generic curve object.

Constructor & Destructor Documentation

◆ GeomAPI_Curve() [1/2]

GeomAPI_Curve::GeomAPI_Curve ( )

Creation of empty (null) shape.

◆ GeomAPI_Curve() [2/2]

GeomAPI_Curve::GeomAPI_Curve ( const std::shared_ptr< GeomAPI_Shape > &  theShape)

Creates a curve from the shape (edge)

Member Function Documentation

◆ isNull()

bool GeomAPI_Curve::isNull ( ) const

Returns true if curve is not initialized.

◆ isEqual()

bool GeomAPI_Curve::isEqual ( const std::shared_ptr< GeomAPI_Curve > &  theOther) const

Returns true if curves are equal.

◆ isLine()

bool GeomAPI_Curve::isLine ( ) const
virtual

Returns whether the curve is linear.

◆ isCircle()

bool GeomAPI_Curve::isCircle ( ) const
virtual

Returns whether the curve is circular.

◆ isEllipse()

bool GeomAPI_Curve::isEllipse ( ) const
virtual

Returns whether the curve is elliptic.

◆ startParam()

double GeomAPI_Curve::startParam ( )

Returns start parameter of the curve.

◆ endParam()

double GeomAPI_Curve::endParam ( )

Returns end parameter of the curve.

◆ isTrimmed()

bool GeomAPI_Curve::isTrimmed ( ) const
virtual

Returns true if the curve is trimmed.

◆ basisCurve()

GeomCurvePtr GeomAPI_Curve::basisCurve ( ) const
virtual

Returns basis for the trimmed curve.

◆ getPoint()

std::shared_ptr< GeomAPI_Pnt > GeomAPI_Curve::getPoint ( double  theParam)

Returns point on the curve by parameter.

Parameters
theParamparameter on the curve

◆ project()

const std::shared_ptr< GeomAPI_Pnt > GeomAPI_Curve::project ( const std::shared_ptr< GeomAPI_Pnt > &  thePoint) const

Project point on curve.

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