Interface for Translation feature. More...

Inheritance diagram for SketchAPI_Translation:

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_AttributeRefList >	translationList () const
	Translation list. More...

virtual std::shared_ptr< ModelAPI_AttributeRefAttr >	startPoint () const
	Start point. More...

virtual std::shared_ptr< ModelAPI_AttributeRefAttr >	endPoint () const
	Start point. More...

virtual std::shared_ptr< ModelAPI_AttributeInteger >	numberOfObjects () const
	Number of objects. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	valueType () const
	Value type. More...

virtual std::shared_ptr< ModelAPI_AttributeRefList >	referenceObjects () const
	Reference objects. More...

virtual std::shared_ptr< ModelAPI_AttributeRefList >	translatedObjects () 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_Feature >	feature () const
	Return ModelAPI_Feature. More...

std::shared_ptr< ModelHighAPI_Interface >	subFeature (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_Selection >	results () const
	Return all objects of the feature. More...

virtual std::shared_ptr< ModelAPI_Result >	defaultResult () 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...

virtual ListOfShape	vertices (const bool theOnlyUnique=false)
	Returns all the vertices produced by this feature. More...

virtual ListOfShape	edges (const bool theOnlyUnique=false)
	Returns all the edges produced by this feature. More...

virtual ListOfShape	wires (const bool theOnlyUnique=false)
	Returns all the wires produced by this feature. More...

virtual ListOfShape	faces (const bool theOnlyUnique=false)
	Returns all the faces produced by this feature. More...

virtual ListOfShape	shells (const bool theOnlyUnique=false)
	Returns all the shells produced by this feature. More...

virtual ListOfShape	solids (const bool theOnlyUnique=false)
	Returns all the solids produced by this feature. More...

Static Public Member Functions
static std::string	ID ()

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeRefList >	mytranslationList

std::shared_ptr< ModelAPI_AttributeRefAttr >	mystartPoint

std::shared_ptr< ModelAPI_AttributeRefAttr >	myendPoint

std::shared_ptr< ModelAPI_AttributeInteger >	mynumberOfObjects

std::shared_ptr< ModelAPI_AttributeString >	myvalueType

std::shared_ptr< ModelAPI_AttributeRefList >	myreferenceObjects

std::shared_ptr< ModelAPI_AttributeRefList >	mytranslatedObjects

std::shared_ptr< ModelAPI_Feature >	myFeature
	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

Return ModelAPI_Feature.

◆ 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

isForce start 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.

◆ vertices()

ListOfShape ModelHighAPI_Interface::vertices ( const bool theOnlyUnique = false )

virtualinherited

Returns all the vertices produced by this feature.

◆ edges()

ListOfShape ModelHighAPI_Interface::edges ( const bool theOnlyUnique = false )

virtualinherited

Returns all the edges produced by this feature.

◆ wires()

ListOfShape ModelHighAPI_Interface::wires ( const bool theOnlyUnique = false )

virtualinherited

Returns all the wires produced by this feature.

◆ faces()

ListOfShape ModelHighAPI_Interface::faces ( const bool theOnlyUnique = false )

virtualinherited

Returns all the faces produced by this feature.

◆ shells()

ListOfShape ModelHighAPI_Interface::shells ( const bool theOnlyUnique = false )

virtualinherited

Returns all the shells produced by this feature.

◆ solids()

ListOfShape ModelHighAPI_Interface::solids ( const bool theOnlyUnique = false )

virtualinherited

Returns all the solids produced by this feature.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SketchAPI_Translation() [1/2]

◆ SketchAPI_Translation() [2/2]

◆ ~SketchAPI_Translation()

Member Function Documentation

◆ translationList()

◆ startPoint()

◆ endPoint()

◆ numberOfObjects()

◆ valueType()

◆ referenceObjects()

◆ translatedObjects()

◆ setTranslationList()

◆ translated()

◆ translatedList()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter