SHAPER  9.12.0
FeaturesAPI_Translation Class Reference

Interface for Translation feature. More...

Inheritance diagram for FeaturesAPI_Translation:
Inheritance graph

Public Member Functions

 FeaturesAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 FeaturesAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theMainObjects, const ModelHighAPI_Selection &theAxisObject, const ModelHighAPI_Double &theDistance)
 Constructor with values. More...
 
 FeaturesAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theMainObjects, const ModelHighAPI_Double &theDx, const ModelHighAPI_Double &theDy, const ModelHighAPI_Double &theDz)
 Constructor with values. More...
 
 FeaturesAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theMainObjects, const ModelHighAPI_Selection &theStartPoint, const ModelHighAPI_Selection &theEndPoint)
 Constructor with values. More...
 
virtual ~FeaturesAPI_Translation ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeStringcreationMethod () const
 Creation method. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListmainObjects () const
 Main objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionaxisObject () const
 Axis object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubledistance () const
 Distance. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubledx () const
 Dimension in X. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubledy () const
 Dimension in Y. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubledz () const
 Dimension in Z. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionstartPoint () const
 Start point object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionendPoint () const
 End point object. More...
 
void setMainObjects (const std::list< ModelHighAPI_Selection > &theMainObjects)
 Set main objects. More...
 
void setAxisAndDistance (const ModelHighAPI_Selection &theAxisObject, const ModelHighAPI_Double &theDistance)
 Modify CreationMethod, axis_object, distance attributes of the feature. More...
 
void setDimensions (const ModelHighAPI_Double &theDx, const ModelHighAPI_Double &theDy, const ModelHighAPI_Double &theDz)
 Modify CreationMethod, dx, dy, dz attributes of the feature. More...
 
void setPoints (const ModelHighAPI_Selection &theStartPoint, const ModelHighAPI_Selection &theEndPoint)
 Modify CreationMethod, start_point, end_point attributes 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_AttributeStringmycreationMethod
 
std::shared_ptr< ModelAPI_AttributeSelectionListmymainObjects
 
std::shared_ptr< ModelAPI_AttributeSelectionmyaxisObject
 
std::shared_ptr< ModelAPI_AttributeDoublemydistance
 
std::shared_ptr< ModelAPI_AttributeDoublemydx
 
std::shared_ptr< ModelAPI_AttributeDoublemydy
 
std::shared_ptr< ModelAPI_AttributeDoublemydz
 
std::shared_ptr< ModelAPI_AttributeSelectionmystartPoint
 
std::shared_ptr< ModelAPI_AttributeSelectionmyendPoint
 
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 Translation feature.

Constructor & Destructor Documentation

◆ FeaturesAPI_Translation() [1/4]

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

Constructor without values.

◆ FeaturesAPI_Translation() [2/4]

FeaturesAPI_Translation::FeaturesAPI_Translation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theMainObjects,
const ModelHighAPI_Selection theAxisObject,
const ModelHighAPI_Double theDistance 
)
explicit

Constructor with values.

◆ FeaturesAPI_Translation() [3/4]

FeaturesAPI_Translation::FeaturesAPI_Translation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theMainObjects,
const ModelHighAPI_Double theDx,
const ModelHighAPI_Double theDy,
const ModelHighAPI_Double theDz 
)
explicit

Constructor with values.

◆ FeaturesAPI_Translation() [4/4]

FeaturesAPI_Translation::FeaturesAPI_Translation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theMainObjects,
const ModelHighAPI_Selection theStartPoint,
const ModelHighAPI_Selection theEndPoint 
)
explicit

Constructor with values.

◆ ~FeaturesAPI_Translation()

FeaturesAPI_Translation::~FeaturesAPI_Translation ( )
virtual

Destructor.

Member Function Documentation

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > FeaturesAPI_Translation::creationMethod ( ) const
inlinevirtual

Creation method.

◆ mainObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_Translation::mainObjects ( ) const
inlinevirtual

Main objects.

◆ axisObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Translation::axisObject ( ) const
inlinevirtual

Axis object.

◆ distance()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_Translation::distance ( ) const
inlinevirtual

Distance.

◆ dx()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_Translation::dx ( ) const
inlinevirtual

Dimension in X.

◆ dy()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_Translation::dy ( ) const
inlinevirtual

Dimension in Y.

◆ dz()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_Translation::dz ( ) const
inlinevirtual

Dimension in Z.

◆ startPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Translation::startPoint ( ) const
inlinevirtual

Start point object.

◆ endPoint()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Translation::endPoint ( ) const
inlinevirtual

End point object.

◆ setMainObjects()

void FeaturesAPI_Translation::setMainObjects ( const std::list< ModelHighAPI_Selection > &  theMainObjects)

Set main objects.

◆ setAxisAndDistance()

void FeaturesAPI_Translation::setAxisAndDistance ( const ModelHighAPI_Selection theAxisObject,
const ModelHighAPI_Double theDistance 
)

Modify CreationMethod, axis_object, distance attributes of the feature.

◆ setDimensions()

void FeaturesAPI_Translation::setDimensions ( const ModelHighAPI_Double theDx,
const ModelHighAPI_Double theDy,
const ModelHighAPI_Double theDz 
)

Modify CreationMethod, dx, dy, dz attributes of the feature.

◆ setPoints()

void FeaturesAPI_Translation::setPoints ( const ModelHighAPI_Selection theStartPoint,
const ModelHighAPI_Selection theEndPoint 
)

Modify CreationMethod, start_point, end_point attributes of the feature.

◆ dump()

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