SHAPER  9.12.0
SketchAPI_Ellipse Class Reference

Interface for Ellipse feature. More...

Inheritance diagram for SketchAPI_Ellipse:
Inheritance graph

Public Member Functions

 SketchAPI_Ellipse (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 SketchAPI_Ellipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, double theCenterX, double theCenterY, double theFocusX, double theFocusY, double theMinorRadius)
 Constructor with values. More...
 
 SketchAPI_Ellipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, const std::shared_ptr< GeomAPI_Pnt2d > &theFocus, double theMinorRadius)
 Constructor with values. More...
 
 SketchAPI_Ellipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theExternal)
 Constructor with external. More...
 
 SketchAPI_Ellipse (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::wstring &theExternalName)
 Constructor with external. More...
 
virtual ~SketchAPI_Ellipse ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< GeomDataAPI_Point2Dcenter () const
 Center point. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DfirstFocus () const
 Focus in positive direction of a major axis. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DsecondFocus () const
 Focus in negative direction of a major axis. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DmajorAxisNegative () const
 Start point of major axis. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DmajorAxisPositive () const
 End point of major axis. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DminorAxisNegative () const
 Start point of minor axis. More...
 
virtual std::shared_ptr< GeomDataAPI_Point2DminorAxisPositive () const
 End point of minor axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublemajorRadius () const
 Major radius. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubleminorRadius () const
 Minor radius. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionexternal () const
 External. More...
 
void setByCenterFocusAndRadius (double theCenterX, double theCenterY, double theFocusX, double theFocusY, double theMinorRadius)
 Set by center, focus and radius. More...
 
void setByCenterFocusAndRadius (const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, const std::shared_ptr< GeomAPI_Pnt2d > &theFocus, double theMinorRadius)
 Set by center, focus and radius. More...
 
void setByExternal (const ModelHighAPI_Selection &theExternal)
 Set by external. More...
 
void setByExternalName (const std::wstring &theExternalName)
 Set by external name. More...
 
void setCenter (double theX, double theY)
 Set center. More...
 
void setCenter (const std::shared_ptr< GeomAPI_Pnt2d > &theCenter)
 Set center. More...
 
void setFocus (double theX, double theY)
 Set focus. More...
 
void setFocus (const std::shared_ptr< GeomAPI_Pnt2d > &theFocus)
 Set focus. More...
 
void setMinorRadius (double theRadius)
 Set radius. More...
 
std::list< std::shared_ptr< SketchAPI_SketchEntity > > construction (const std::wstring &center=std::wstring(), const std::wstring &firstFocus=std::wstring(), const std::wstring &secondFocus=std::wstring(), const std::wstring &majorAxisStart=std::wstring(), const std::wstring &majorAxisEnd=std::wstring(), const std::wstring &minorAxisStart=std::wstring(), const std::wstring &minorAxisEnd=std::wstring(), const std::wstring &majorAxis=std::wstring(), const std::wstring &minorAxis=std::wstring()) const
 Create construction elements (focuses, axes etc.). 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

bool initialize ()
 
bool isCopy () const
 Check the entity is a copy of another feature. More...
 

Protected Attributes

std::shared_ptr< GeomDataAPI_Point2Dmycenter
 
std::shared_ptr< GeomDataAPI_Point2DmyfirstFocus
 
std::shared_ptr< GeomDataAPI_Point2DmysecondFocus
 
std::shared_ptr< GeomDataAPI_Point2DmymajorAxisNegative
 
std::shared_ptr< GeomDataAPI_Point2DmymajorAxisPositive
 
std::shared_ptr< GeomDataAPI_Point2DmyminorAxisNegative
 
std::shared_ptr< GeomDataAPI_Point2DmyminorAxisPositive
 
std::shared_ptr< ModelAPI_AttributeDoublemymajorRadius
 
std::shared_ptr< ModelAPI_AttributeDoublemyminorRadius
 
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...
 

Friends

class SketchAPI_EllipticArc
 

Detailed Description

Interface for Ellipse feature.

Constructor & Destructor Documentation

◆ SketchAPI_Ellipse() [1/5]

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

Constructor without values.

◆ SketchAPI_Ellipse() [2/5]

SketchAPI_Ellipse::SketchAPI_Ellipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
double  theCenterX,
double  theCenterY,
double  theFocusX,
double  theFocusY,
double  theMinorRadius 
)

Constructor with values.

◆ SketchAPI_Ellipse() [3/5]

SketchAPI_Ellipse::SketchAPI_Ellipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::shared_ptr< GeomAPI_Pnt2d > &  theCenter,
const std::shared_ptr< GeomAPI_Pnt2d > &  theFocus,
double  theMinorRadius 
)

Constructor with values.

◆ SketchAPI_Ellipse() [4/5]

SketchAPI_Ellipse::SketchAPI_Ellipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const ModelHighAPI_Selection theExternal 
)

Constructor with external.

◆ SketchAPI_Ellipse() [5/5]

SketchAPI_Ellipse::SketchAPI_Ellipse ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::wstring &  theExternalName 
)

Constructor with external.

◆ ~SketchAPI_Ellipse()

SketchAPI_Ellipse::~SketchAPI_Ellipse ( )
virtual

Destructor.

Member Function Documentation

◆ center()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::center ( ) const
inlinevirtual

Center point.

◆ firstFocus()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::firstFocus ( ) const
inlinevirtual

Focus in positive direction of a major axis.

◆ secondFocus()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::secondFocus ( ) const
inlinevirtual

Focus in negative direction of a major axis.

◆ majorAxisNegative()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::majorAxisNegative ( ) const
inlinevirtual

Start point of major axis.

◆ majorAxisPositive()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::majorAxisPositive ( ) const
inlinevirtual

End point of major axis.

◆ minorAxisNegative()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::minorAxisNegative ( ) const
inlinevirtual

Start point of minor axis.

◆ minorAxisPositive()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_Ellipse::minorAxisPositive ( ) const
inlinevirtual

End point of minor axis.

◆ majorRadius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_Ellipse::majorRadius ( ) const
inlinevirtual

Major radius.

◆ minorRadius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_Ellipse::minorRadius ( ) const
inlinevirtual

Minor radius.

◆ external()

virtual std::shared_ptr< ModelAPI_AttributeSelection > SketchAPI_Ellipse::external ( ) const
inlinevirtual

External.

◆ setByCenterFocusAndRadius() [1/2]

void SketchAPI_Ellipse::setByCenterFocusAndRadius ( double  theCenterX,
double  theCenterY,
double  theFocusX,
double  theFocusY,
double  theMinorRadius 
)

Set by center, focus and radius.

◆ setByCenterFocusAndRadius() [2/2]

void SketchAPI_Ellipse::setByCenterFocusAndRadius ( const std::shared_ptr< GeomAPI_Pnt2d > &  theCenter,
const std::shared_ptr< GeomAPI_Pnt2d > &  theFocus,
double  theMinorRadius 
)

Set by center, focus and radius.

◆ setByExternal()

void SketchAPI_Ellipse::setByExternal ( const ModelHighAPI_Selection theExternal)

Set by external.

◆ setByExternalName()

void SketchAPI_Ellipse::setByExternalName ( const std::wstring &  theExternalName)

Set by external name.

◆ setCenter() [1/2]

void SketchAPI_Ellipse::setCenter ( double  theX,
double  theY 
)

Set center.

◆ setCenter() [2/2]

void SketchAPI_Ellipse::setCenter ( const std::shared_ptr< GeomAPI_Pnt2d > &  theCenter)

Set center.

◆ setFocus() [1/2]

void SketchAPI_Ellipse::setFocus ( double  theX,
double  theY 
)

Set focus.

◆ setFocus() [2/2]

void SketchAPI_Ellipse::setFocus ( const std::shared_ptr< GeomAPI_Pnt2d > &  theFocus)

Set focus.

◆ setMinorRadius()

void SketchAPI_Ellipse::setMinorRadius ( double  theRadius)

Set radius.

◆ construction()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_Ellipse::construction ( const std::wstring &  center = std::wstring(),
const std::wstring &  firstFocus = std::wstring(),
const std::wstring &  secondFocus = std::wstring(),
const std::wstring &  majorAxisStart = std::wstring(),
const std::wstring &  majorAxisEnd = std::wstring(),
const std::wstring &  minorAxisStart = std::wstring(),
const std::wstring &  minorAxisEnd = std::wstring(),
const std::wstring &  majorAxis = std::wstring(),
const std::wstring &  minorAxis = std::wstring() 
) const

Create construction elements (focuses, axes etc.).

Empty value for each parameter shows that the corresponding feature has been removed. Value "aux" marks this feature as auxiliary. And the name of the feature shows that it is a regular feature.

◆ dump()

void SketchAPI_Ellipse::dump ( ModelHighAPI_Dumper theDumper) const
virtual

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