SHAPER  9.12.0
BuildAPI_Filling Class Reference

Interface for Filling feature. More...

Inheritance diagram for BuildAPI_Filling:
Inheritance graph

Public Member Functions

 BuildAPI_Filling (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 BuildAPI_Filling (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects)
 Constructor with base objects. More...
 
 BuildAPI_Filling (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const std::string &theOrientCorrection, const int theMinDegree, const int theMaxDegree, const int theNbIter, const double theTolerance2D, const double theTolerance3D, const bool theApproximate)
 Constructor with values. More...
 
virtual ~BuildAPI_Filling ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListbaseObjects () const
 Base objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringorientationMethod () const
 Method to keep edge orientaion. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegerminDegree () const
 Minimal degree. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegermaxDegree () const
 Maximal degree. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegernbIterations () const
 Number of iterations. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubletolerance2d () const
 2D tolerance More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubletolerance3d () const
 3D tolerance More...
 
virtual std::shared_ptr< ModelAPI_AttributeBooleanapproximate () const
 Approximate original edges. More...
 
void setBase (const std::list< ModelHighAPI_Selection > &theBaseObjects)
 Modify base attribute of the feature. More...
 
void setOrientationMethod (const std::string &theMethod)
 Modify orientation method. More...
 
void setMinDegree (const int theMinDegree)
 Modify minimal degree of result B-spline. More...
 
void setMaxDegree (const int theMaxDegree)
 Modify maximal degree of result B-spline. More...
 
void setNbIterations (const int theNbIter)
 Modify number of iterations. More...
 
void setTolerance2d (const double theTol2d)
 Set 2D tolerance. More...
 
void setTolerance3d (const double theTol3d)
 Set 3D tolerance. More...
 
void setApproximation (const bool theApproximate)
 Set approximation flag. 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_AttributeSelectionListmybaseObjects
 
std::shared_ptr< ModelAPI_AttributeStringmyorientationMethod
 
std::shared_ptr< ModelAPI_AttributeIntegermyminDegree
 
std::shared_ptr< ModelAPI_AttributeIntegermymaxDegree
 
std::shared_ptr< ModelAPI_AttributeIntegermynbIterations
 
std::shared_ptr< ModelAPI_AttributeDoublemytolerance2d
 
std::shared_ptr< ModelAPI_AttributeDoublemytolerance3d
 
std::shared_ptr< ModelAPI_AttributeBooleanmyapproximate
 
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 Filling feature.

Constructor & Destructor Documentation

◆ BuildAPI_Filling() [1/3]

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

Constructor without values.

◆ BuildAPI_Filling() [2/3]

BuildAPI_Filling::BuildAPI_Filling ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theBaseObjects 
)
explicit

Constructor with base objects.

◆ BuildAPI_Filling() [3/3]

BuildAPI_Filling::BuildAPI_Filling ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theBaseObjects,
const std::string &  theOrientCorrection,
const int  theMinDegree,
const int  theMaxDegree,
const int  theNbIter,
const double  theTolerance2D,
const double  theTolerance3D,
const bool  theApproximate 
)
explicit

Constructor with values.

◆ ~BuildAPI_Filling()

BuildAPI_Filling::~BuildAPI_Filling ( )
virtual

Destructor.

Member Function Documentation

◆ baseObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > BuildAPI_Filling::baseObjects ( ) const
inlinevirtual

Base objects.

◆ orientationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Filling::orientationMethod ( ) const
inlinevirtual

Method to keep edge orientaion.

◆ minDegree()

virtual std::shared_ptr< ModelAPI_AttributeInteger > BuildAPI_Filling::minDegree ( ) const
inlinevirtual

Minimal degree.

◆ maxDegree()

virtual std::shared_ptr< ModelAPI_AttributeInteger > BuildAPI_Filling::maxDegree ( ) const
inlinevirtual

Maximal degree.

◆ nbIterations()

virtual std::shared_ptr< ModelAPI_AttributeInteger > BuildAPI_Filling::nbIterations ( ) const
inlinevirtual

Number of iterations.

◆ tolerance2d()

virtual std::shared_ptr< ModelAPI_AttributeDouble > BuildAPI_Filling::tolerance2d ( ) const
inlinevirtual

2D tolerance

◆ tolerance3d()

virtual std::shared_ptr< ModelAPI_AttributeDouble > BuildAPI_Filling::tolerance3d ( ) const
inlinevirtual

3D tolerance

◆ approximate()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > BuildAPI_Filling::approximate ( ) const
inlinevirtual

Approximate original edges.

◆ setBase()

void BuildAPI_Filling::setBase ( const std::list< ModelHighAPI_Selection > &  theBaseObjects)

Modify base attribute of the feature.

◆ setOrientationMethod()

void BuildAPI_Filling::setOrientationMethod ( const std::string &  theMethod)

Modify orientation method.

◆ setMinDegree()

void BuildAPI_Filling::setMinDegree ( const int  theMinDegree)

Modify minimal degree of result B-spline.

◆ setMaxDegree()

void BuildAPI_Filling::setMaxDegree ( const int  theMaxDegree)

Modify maximal degree of result B-spline.

◆ setNbIterations()

void BuildAPI_Filling::setNbIterations ( const int  theNbIter)

Modify number of iterations.

◆ setTolerance2d()

void BuildAPI_Filling::setTolerance2d ( const double  theTol2d)

Set 2D tolerance.

◆ setTolerance3d()

void BuildAPI_Filling::setTolerance3d ( const double  theTol3d)

Set 3D tolerance.

◆ setApproximation()

void BuildAPI_Filling::setApproximation ( const bool  theApproximate)

Set approximation flag.

◆ dump()

void BuildAPI_Filling::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