SHAPER  9.12.0
SketchAPI_MacroMiddlePoint Class Reference

Interface for Middle Point feature. More...

Inheritance diagram for SketchAPI_MacroMiddlePoint:
Inheritance graph

Public Member Functions

 SketchAPI_MacroMiddlePoint (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 SketchAPI_MacroMiddlePoint (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_RefAttr &theLine, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint)
 Constructor with line and middle point coordinates. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< GeomDataAPI_Point2Dcoordinates () const
 Point coordinates. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionexternal () const
 External. More...
 
void setCoordinates (double theX, double theY)
 Set by coordinates. More...
 
void setCoordinates (const std::shared_ptr< GeomAPI_Pnt2d > &thePoint)
 Set by points. More...
 
void setByExternal (const ModelHighAPI_Selection &theExternal)
 Set by external. More...
 
void setByExternalName (const std::wstring &theExternalName)
 Set by external name. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_AttributeBooleanauxiliary () const
 Auxiliary. More...
 
void setAuxiliary (bool theAuxiliary)
 Set auxiliary. 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 ()
 
static std::list< std::shared_ptr< SketchAPI_SketchEntity > > wrap (const std::list< std::shared_ptr< ModelAPI_Feature > > &theFeatures)
 Convert list of features to list of appropriate wrappers. More...
 

Protected Member Functions

void createConstraint (const ModelHighAPI_RefAttr &theLine)
 
bool initialize ()
 
bool isCopy () const
 Check the entity is a copy of another feature. More...
 

Protected Attributes

std::shared_ptr< GeomDataAPI_Point2Dmycoordinates
 
std::shared_ptr< ModelAPI_AttributeSelectionmyexternal
 
std::shared_ptr< ModelAPI_AttributeBooleanmyAuxiliary
 
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 Middle Point feature.

Constructor & Destructor Documentation

◆ SketchAPI_MacroMiddlePoint() [1/2]

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

Constructor without values.

◆ SketchAPI_MacroMiddlePoint() [2/2]

SketchAPI_MacroMiddlePoint::SketchAPI_MacroMiddlePoint ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_RefAttr theLine,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint 
)

Constructor with line and middle point coordinates.

Member Function Documentation

◆ coordinates()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Point::coordinates ( ) const
inlinevirtualinherited

Point coordinates.

◆ external()

virtual std::shared_ptr< ModelAPI_AttributeSelection > SketchAPI_Point::external ( ) const
inlinevirtualinherited

External.

◆ setCoordinates() [1/2]

void SketchAPI_Point::setCoordinates ( double  theX,
double  theY 
)
inherited

Set by coordinates.

◆ setCoordinates() [2/2]

void SketchAPI_Point::setCoordinates ( const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint)
inherited

Set by points.

◆ setByExternal()

void SketchAPI_Point::setByExternal ( const ModelHighAPI_Selection theExternal)
inherited

Set by external.

◆ setByExternalName()

void SketchAPI_Point::setByExternalName ( const std::wstring &  theExternalName)
inherited

Set by external name.

◆ dump()

void SketchAPI_Point::dump ( ModelHighAPI_Dumper theDumper) const
virtualinherited

Dump wrapped feature.

Reimplemented from SketchAPI_SketchEntity.

◆ auxiliary()

std::shared_ptr< ModelAPI_AttributeBoolean > SketchAPI_SketchEntity::auxiliary ( ) const
inherited

Auxiliary.

◆ setAuxiliary()

void SketchAPI_SketchEntity::setAuxiliary ( bool  theAuxiliary)
inherited

Set auxiliary.

◆ wrap()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_SketchEntity::wrap ( const std::list< std::shared_ptr< ModelAPI_Feature > > &  theFeatures)
staticinherited

Convert list of features to list of appropriate wrappers.

◆ isCopy()

bool SketchAPI_SketchEntity::isCopy ( ) const
protectedinherited

Check the entity is a copy of another feature.

◆ 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