SHAPER  9.12.0
SketchAPI_Rotation Class Reference

Interface for Rotation feature. More...

Inheritance diagram for SketchAPI_Rotation:
Inheritance graph

Public Member Functions

 SketchAPI_Rotation (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 SketchAPI_Rotation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< std::shared_ptr< ModelAPI_Object > > &theObjects, const ModelHighAPI_RefAttr &theCenter, const ModelHighAPI_Double &theAngle, const ModelHighAPI_Integer &theNumberOfObjects, bool theFullValue=false, bool theReversed=false)
 Constructor with values. More...
virtual ~SketchAPI_Rotation ()
 Destructor. More...
virtual std::string getID ()
virtual std::shared_ptr< ModelAPI_AttributeRefListrotationList () const
 Rotation list. More...
virtual std::shared_ptr< ModelAPI_AttributeRefAttrcenter () const
 Center. More...
virtual std::shared_ptr< ModelAPI_AttributeDoubleangle () const
 Angle. More...
virtual std::shared_ptr< ModelAPI_AttributeBooleanreversed () const
 Negative angle. 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_AttributeRefListrotatedObjects () const
 Rotated objects. More...
void setRotationList (const std::list< std::shared_ptr< ModelAPI_Object > > &theObjects)
 Set list of objects to be rotated. More...
std::list< std::shared_ptr< SketchAPI_SketchEntity > > rotated () const
 List of rotated objects. More...
std::list< std::shared_ptr< SketchAPI_SketchEntity > > rotatedList () const
 List of rotated 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_AttributeRefListmyrotationList
std::shared_ptr< ModelAPI_AttributeRefAttrmycenter
std::shared_ptr< ModelAPI_AttributeDoublemyangle
std::shared_ptr< ModelAPI_AttributeBooleanmyreversed
std::shared_ptr< ModelAPI_AttributeIntegermynumberOfObjects
std::shared_ptr< ModelAPI_AttributeStringmyvalueType
std::shared_ptr< ModelAPI_AttributeRefListmyreferenceObjects
std::shared_ptr< ModelAPI_AttributeRefListmyrotatedObjects
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 Rotation feature.

Constructor & Destructor Documentation

◆ SketchAPI_Rotation() [1/2]

SketchAPI_Rotation::SketchAPI_Rotation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)

Constructor without values.

◆ SketchAPI_Rotation() [2/2]

SketchAPI_Rotation::SketchAPI_Rotation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< std::shared_ptr< ModelAPI_Object > > &  theObjects,
const ModelHighAPI_RefAttr theCenter,
const ModelHighAPI_Double theAngle,
const ModelHighAPI_Integer theNumberOfObjects,
bool  theFullValue = false,
bool  theReversed = false 

Constructor with values.

◆ ~SketchAPI_Rotation()

SketchAPI_Rotation::~SketchAPI_Rotation ( )


Member Function Documentation

◆ rotationList()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Rotation::rotationList ( ) const

Rotation list.

◆ center()

virtual std::shared_ptr< ModelAPI_AttributeRefAttr > SketchAPI_Rotation::center ( ) const


◆ angle()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_Rotation::angle ( ) const


◆ reversed()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > SketchAPI_Rotation::reversed ( ) const

Negative angle.

◆ numberOfObjects()

virtual std::shared_ptr< ModelAPI_AttributeInteger > SketchAPI_Rotation::numberOfObjects ( ) const

Number of objects.

◆ valueType()

virtual std::shared_ptr< ModelAPI_AttributeString > SketchAPI_Rotation::valueType ( ) const

Value type.

◆ referenceObjects()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Rotation::referenceObjects ( ) const

Reference objects.

◆ rotatedObjects()

virtual std::shared_ptr< ModelAPI_AttributeRefList > SketchAPI_Rotation::rotatedObjects ( ) const

Rotated objects.

◆ setRotationList()

void SketchAPI_Rotation::setRotationList ( const std::list< std::shared_ptr< ModelAPI_Object > > &  theObjects)

Set list of objects to be rotated.

◆ rotated()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_Rotation::rotated ( ) const

List of rotated objects.

[DEPRECATED]: use rotatedList() instead.

◆ rotatedList()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_Rotation::rotatedList ( ) const

List of rotated objects.

◆ dump()

void SketchAPI_Rotation::dump ( ModelHighAPI_Dumper theDumper) const

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ feature()

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

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > 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.

◆ getKind()

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

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool  isForce = false)

Shortcut for feature()->execute()

isForcestart execution of feature instead of sending events

◆ setName()

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

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

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const

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

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const

Return firts object of the feature.

◆ results()

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

Return all objects of the feature.

◆ defaultResult()

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

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

◆ throwException()

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

Throw exception to event loop.

◆ attributeGetter()

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

Return name of getter for specified attribute.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature

feature of this interface

◆ myAttrGetter

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

names of attributes and their getters