SHAPER  9.12.0
FeaturesAPI_PointCloudOnFace Class Reference

Interface for PointCloudOnFace feature. More...

Inheritance diagram for FeaturesAPI_PointCloudOnFace:
Inheritance graph

Public Member Functions

 FeaturesAPI_PointCloudOnFace (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 FeaturesAPI_PointCloudOnFace (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theFace, const ModelHighAPI_Integer &theNumber)
 Constructor with values. More...
 
virtual ~FeaturesAPI_PointCloudOnFace ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionfaceSelected () const
 face More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegernbPoints () const
 Number of points. More...
 
void setNumberOfPoints (const ModelHighAPI_Integer &theNumber)
 Modify CreationMethod, nb_points attribute of the feature. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_Featurefeature () const
 Return ModelAPI_Feature. More...
 
std::shared_ptr< ModelHighAPI_InterfacesubFeature (const int theIndex) const
 If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index. More...
 
const std::string & getKind () const
 Shortcut for feature()->getKind() More...
 
void execute (bool isForce=false)
 Shortcut for feature()->execute() More...
 
void setName (const std::wstring &theName)
 Shortcut for feature()->data()->setName() More...
 
std::wstring name () const
 Shortcut for feature()->data()->name() More...
 
virtual ModelHighAPI_Selection result () const
 Return firts object of the feature. More...
 
virtual std::list< ModelHighAPI_Selectionresults () const
 Return all objects of the feature. More...
 
virtual std::shared_ptr< ModelAPI_ResultdefaultResult () const
 Return default result. Default implementation feature()->lastResult() More...
 
void throwException (const std::string &theDescription)
 Throw exception to event loop. More...
 
const std::string & attributeGetter (const std::string &theAttrName)
 Return name of getter for specified attribute. More...
 

Static Public Member Functions

static std::string ID ()
 

Protected Member Functions

bool initialize ()
 

Protected Attributes

std::shared_ptr< ModelAPI_AttributeSelectionmyfaceSelected
 
std::shared_ptr< ModelAPI_AttributeIntegermynbPoints
 
std::shared_ptr< ModelAPI_FeaturemyFeature
 feature of this interface More...
 
std::map< std::string, std::string > myAttrGetter
 names of attributes and their getters More...
 

Detailed Description

Interface for PointCloudOnFace feature.

Constructor & Destructor Documentation

◆ FeaturesAPI_PointCloudOnFace() [1/2]

FeaturesAPI_PointCloudOnFace::FeaturesAPI_PointCloudOnFace ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)
explicit

Constructor without values.

◆ FeaturesAPI_PointCloudOnFace() [2/2]

FeaturesAPI_PointCloudOnFace::FeaturesAPI_PointCloudOnFace ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Selection theFace,
const ModelHighAPI_Integer theNumber 
)
explicit

Constructor with values.

◆ ~FeaturesAPI_PointCloudOnFace()

FeaturesAPI_PointCloudOnFace::~FeaturesAPI_PointCloudOnFace ( )
virtual

Destructor.

Member Function Documentation

◆ faceSelected()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_PointCloudOnFace::faceSelected ( ) const
inlinevirtual

face

◆ nbPoints()

virtual std::shared_ptr< ModelAPI_AttributeInteger > FeaturesAPI_PointCloudOnFace::nbPoints ( ) const
inlinevirtual

Number of points.

◆ setNumberOfPoints()

void FeaturesAPI_PointCloudOnFace::setNumberOfPoints ( const ModelHighAPI_Integer theNumber)

Modify CreationMethod, nb_points attribute of the feature.

◆ dump()

void FeaturesAPI_PointCloudOnFace::dump ( ModelHighAPI_Dumper theDumper) const
virtual

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ feature()

std::shared_ptr< ModelAPI_Feature > ModelHighAPI_Interface::feature ( ) const
inherited

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > ModelHighAPI_Interface::subFeature ( const int  theIndex) const
inherited

If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index.

◆ getKind()

const std::string & ModelHighAPI_Interface::getKind ( ) const
inherited

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool  isForce = false)
inherited

Shortcut for feature()->execute()

Parameters
isForcestart execution of feature instead of sending events

◆ setName()

void ModelHighAPI_Interface::setName ( const std::wstring &  theName)
inherited

Shortcut for feature()->data()->setName()

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const
inherited

Shortcut for feature()->data()->name()

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const
virtualinherited

Return firts object of the feature.

◆ results()

std::list< ModelHighAPI_Selection > ModelHighAPI_Interface::results ( ) const
virtualinherited

Return all objects of the feature.

◆ defaultResult()

std::shared_ptr< ModelAPI_Result > ModelHighAPI_Interface::defaultResult ( ) const
virtualinherited

Return default result. Default implementation feature()->lastResult()

◆ throwException()

void ModelHighAPI_Interface::throwException ( const std::string &  theDescription)
inherited

Throw exception to event loop.

◆ attributeGetter()

const std::string & ModelHighAPI_Interface::attributeGetter ( const std::string &  theAttrName)
inherited

Return name of getter for specified attribute.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature
protectedinherited

feature of this interface

◆ myAttrGetter

std::map<std::string, std::string> ModelHighAPI_Interface::myAttrGetter
protectedinherited

names of attributes and their getters