Interface for Ellipse feature. More...

Inheritance diagram for SketchAPI_MacroEllipse:

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_AttributeString >	ellipseType () const
	Ellipse type. More...

std::shared_ptr< SketchAPI_Point >	center ()
	Return created auxiliary center point. More...

std::shared_ptr< SketchAPI_Point >	focus1 ()
	Return created auxiliary focus in the positive direction of major axis. More...

std::shared_ptr< SketchAPI_Point >	focus2 ()
	Return created auxiliary focus in the negative direction of major axis. More...

std::shared_ptr< SketchAPI_Point >	majorAxisStart ()
	Return created auxiliary point - start of major axis. More...

std::shared_ptr< SketchAPI_Point >	majorAxisEnd ()
	Return created auxiliary point - end of major axis. More...

std::shared_ptr< SketchAPI_Point >	minorAxisStart ()
	Return created auxiliary point - start of minor axis. More...

std::shared_ptr< SketchAPI_Point >	minorAxisEnd ()
	Return created auxiliary point - end of minor axis. More...

std::shared_ptr< SketchAPI_Line >	majorAxis ()
	Return created auxiliary major axis. More...

std::shared_ptr< SketchAPI_Line >	minorAxis ()
	Return created auxiliary minor axis. More...

std::shared_ptr< ModelAPI_AttributeBoolean >	auxiliary () 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_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 ()

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_AttributeString >	myellipseType

std::shared_ptr< ModelAPI_AttributeBoolean >	myAuxiliary

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 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

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

Reimplemented in SketchAPI_Projection, SketchAPI_Point, SketchAPI_Line, SketchAPI_IntersectionPoint, SketchAPI_EllipticArc, SketchAPI_Ellipse, SketchAPI_Circle, SketchAPI_BSpline, and SketchAPI_Arc.

◆ 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

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_MacroEllipse() [1/4]

◆ SketchAPI_MacroEllipse() [2/4]

◆ SketchAPI_MacroEllipse() [3/4]

◆ SketchAPI_MacroEllipse() [4/4]

◆ ~SketchAPI_MacroEllipse()

Member Function Documentation

◆ ellipseType()

◆ center()

◆ focus1()

◆ focus2()

◆ majorAxisStart()

◆ majorAxisEnd()

◆ minorAxisStart()

◆ minorAxisEnd()

◆ majorAxis()

◆ minorAxis()

◆ auxiliary()

◆ setAuxiliary()

◆ dump()

◆ wrap()

◆ isCopy()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter