SHAPER  9.12.0
SketchAPI_Translation Class Reference

Interface for Translation feature. More...

Inheritance diagram for SketchAPI_Translation:
Inheritance graph

Public Member Functions

 SketchAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 SketchAPI_Translation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< std::shared_ptr< ModelAPI_Object > > &theObjects, const ModelHighAPI_RefAttr &thePoint1, const ModelHighAPI_RefAttr &thePoint2, const ModelHighAPI_Integer &theNumberOfObjects, bool theFullValue=false)
 Constructor with values. More...
 
virtual ~SketchAPI_Translation ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeRefListtranslationList () const
 Translation list. More...
 
virtual std::shared_ptr< ModelAPI_AttributeRefAttrstartPoint () const
 Start point. More...
 
virtual std::shared_ptr< ModelAPI_AttributeRefAttrendPoint () const
 Start point. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegernumberOfObjects () const
 Number of objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringvalueType () const
 Value type. More...
 
virtual std::shared_ptr< ModelAPI_AttributeRefListreferenceObjects () const
 Reference objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeRefListtranslatedObjects () const
 Translationed objects. More...
 
void setTranslationList (const std::list< std::shared_ptr< ModelAPI_Object > > &theObjects)
 Set list of objects to be translated. More...
 
std::list< std::shared_ptr< SketchAPI_SketchEntity > > translated () const
 List of translated objects. More...
 
std::list< std::shared_ptr< SketchAPI_SketchEntity > > translatedList () const
 List of translated objects. 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_AttributeRefListmytranslationList
 
std::shared_ptr< ModelAPI_AttributeRefAttrmystartPoint
 
std::shared_ptr< ModelAPI_AttributeRefAttrmyendPoint
 
std::shared_ptr< ModelAPI_AttributeIntegermynumberOfObjects
 
std::shared_ptr< ModelAPI_AttributeStringmyvalueType
 
std::shared_ptr< ModelAPI_AttributeRefListmyreferenceObjects
 
std::shared_ptr< ModelAPI_AttributeRefListmytranslatedObjects
 
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

◆ SketchAPI_Translation() [1/2]

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

Constructor without values.

◆ SketchAPI_Translation() [2/2]

SketchAPI_Translation::SketchAPI_Translation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< std::shared_ptr< ModelAPI_Object > > &  theObjects,
const ModelHighAPI_RefAttr thePoint1,
const ModelHighAPI_RefAttr thePoint2,
const ModelHighAPI_Integer theNumberOfObjects,
bool  theFullValue = false 
)

Constructor with values.

◆ ~SketchAPI_Translation()

SketchAPI_Translation::~SketchAPI_Translation ( )
virtual

Destructor.

Member Function Documentation

◆ translationList()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Translation::translationList ( ) const
inlinevirtual

Translation list.

◆ startPoint()

virtual std::shared_ptr< ModelAPI_AttributeRefAttr > SketchAPI_Translation::startPoint ( ) const
inlinevirtual

Start point.

◆ endPoint()

virtual std::shared_ptr< ModelAPI_AttributeRefAttr > SketchAPI_Translation::endPoint ( ) const
inlinevirtual

Start point.

◆ numberOfObjects()

virtual std::shared_ptr< ModelAPI_AttributeInteger > SketchAPI_Translation::numberOfObjects ( ) const
inlinevirtual

Number of objects.

◆ valueType()

virtual std::shared_ptr< ModelAPI_AttributeString > SketchAPI_Translation::valueType ( ) const
inlinevirtual

Value type.

◆ referenceObjects()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Translation::referenceObjects ( ) const
inlinevirtual

Reference objects.

◆ translatedObjects()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Translation::translatedObjects ( ) const
inlinevirtual

Translationed objects.

◆ setTranslationList()

void SketchAPI_Translation::setTranslationList ( const std::list< std::shared_ptr< ModelAPI_Object > > &  theObjects)

Set list of objects to be translated.

◆ translated()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_Translation::translated ( ) const

List of translated objects.

[DEPRECATED]: use translatedList() instead.

◆ translatedList()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_Translation::translatedList ( ) const

List of translated objects.

◆ dump()

void SketchAPI_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