SHAPER  9.12.0
SketchAPI_MacroEllipse Class Reference

Interface for Ellipse feature. More...

Inheritance diagram for SketchAPI_MacroEllipse:
Inheritance graph

Public Member Functions

 SketchAPI_MacroEllipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, bool callInitialize=true)
 Constructor without values. More...
 
 SketchAPI_MacroEllipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, double theX1, double theY1, double theX2, double theY2, double theX3, double theY3, bool byCenter=true)
 Constructor with values. More...
 
 SketchAPI_MacroEllipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint1, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint2, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint3, bool byCenter=true)
 Constructor with values. More...
 
 SketchAPI_MacroEllipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint1, const ModelHighAPI_RefAttr &thePoint1Ref, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint2, const ModelHighAPI_RefAttr &thePoint2Ref, const std::shared_ptr< GeomAPI_Pnt2d > &thePoint3, const ModelHighAPI_RefAttr &thePoint3Ref, bool byCenter=true)
 Constructor with values and/or references. More...
 
virtual ~SketchAPI_MacroEllipse ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeStringellipseType () const
 Ellipse type. More...
 
std::shared_ptr< SketchAPI_Pointcenter ()
 Return created auxiliary center point. More...
 
std::shared_ptr< SketchAPI_Pointfocus1 ()
 Return created auxiliary focus in the positive direction of major axis. More...
 
std::shared_ptr< SketchAPI_Pointfocus2 ()
 Return created auxiliary focus in the negative direction of major axis. More...
 
std::shared_ptr< SketchAPI_PointmajorAxisStart ()
 Return created auxiliary point - start of major axis. More...
 
std::shared_ptr< SketchAPI_PointmajorAxisEnd ()
 Return created auxiliary point - end of major axis. More...
 
std::shared_ptr< SketchAPI_PointminorAxisStart ()
 Return created auxiliary point - start of minor axis. More...
 
std::shared_ptr< SketchAPI_PointminorAxisEnd ()
 Return created auxiliary point - end of minor axis. More...
 
std::shared_ptr< SketchAPI_LinemajorAxis ()
 Return created auxiliary major axis. More...
 
std::shared_ptr< SketchAPI_LineminorAxis ()
 Return created auxiliary minor axis. More...
 
std::shared_ptr< ModelAPI_AttributeBooleanauxiliary () const
 Auxiliary. More...
 
void setAuxiliary (bool theAuxiliary)
 Set auxiliary. 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 ()
 
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

bool initialize ()
 
void storeSketch (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 
bool isCopy () const
 Check the entity is a copy of another feature. More...
 

Protected Attributes

std::shared_ptr< ModelAPI_AttributeStringmyellipseType
 
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 Ellipse feature.

Constructor & Destructor Documentation

◆ SketchAPI_MacroEllipse() [1/4]

SketchAPI_MacroEllipse::SketchAPI_MacroEllipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
bool  callInitialize = true 
)
explicit

Constructor without values.

◆ SketchAPI_MacroEllipse() [2/4]

SketchAPI_MacroEllipse::SketchAPI_MacroEllipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
double  theX1,
double  theY1,
double  theX2,
double  theY2,
double  theX3,
double  theY3,
bool  byCenter = true 
)

Constructor with values.

◆ SketchAPI_MacroEllipse() [3/4]

SketchAPI_MacroEllipse::SketchAPI_MacroEllipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint1,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint2,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint3,
bool  byCenter = true 
)

Constructor with values.

◆ SketchAPI_MacroEllipse() [4/4]

SketchAPI_MacroEllipse::SketchAPI_MacroEllipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint1,
const ModelHighAPI_RefAttr thePoint1Ref,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint2,
const ModelHighAPI_RefAttr thePoint2Ref,
const std::shared_ptr< GeomAPI_Pnt2d > &  thePoint3,
const ModelHighAPI_RefAttr thePoint3Ref,
bool  byCenter = true 
)

Constructor with values and/or references.

◆ ~SketchAPI_MacroEllipse()

SketchAPI_MacroEllipse::~SketchAPI_MacroEllipse ( )
virtual

Destructor.

Member Function Documentation

◆ ellipseType()

virtual std::shared_ptr< ModelAPI_AttributeString > SketchAPI_MacroEllipse::ellipseType ( ) const
inlinevirtual

Ellipse type.

◆ center()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::center ( )

Return created auxiliary center point.

◆ focus1()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::focus1 ( )

Return created auxiliary focus in the positive direction of major axis.

◆ focus2()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::focus2 ( )

Return created auxiliary focus in the negative direction of major axis.

◆ majorAxisStart()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::majorAxisStart ( )

Return created auxiliary point - start of major axis.

◆ majorAxisEnd()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::majorAxisEnd ( )

Return created auxiliary point - end of major axis.

◆ minorAxisStart()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::minorAxisStart ( )

Return created auxiliary point - start of minor axis.

◆ minorAxisEnd()

std::shared_ptr< SketchAPI_Point > SketchAPI_MacroEllipse::minorAxisEnd ( )

Return created auxiliary point - end of minor axis.

◆ majorAxis()

std::shared_ptr< SketchAPI_Line > SketchAPI_MacroEllipse::majorAxis ( )

Return created auxiliary major axis.

◆ minorAxis()

std::shared_ptr< SketchAPI_Line > SketchAPI_MacroEllipse::minorAxis ( )

Return created auxiliary minor axis.

◆ auxiliary()

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

Auxiliary.

◆ setAuxiliary()

void SketchAPI_SketchEntity::setAuxiliary ( bool  theAuxiliary)
inherited

Set auxiliary.

◆ dump()

void SketchAPI_SketchEntity::dump ( ModelHighAPI_Dumper theDumper) const
virtualinherited

◆ 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