Interface for Elliptic Arc feature. More...

Inheritance diagram for SketchAPI_EllipticArc:

Public Member Functions
	SketchAPI_EllipticArc (const std::shared_ptr< ModelAPI_Feature > &theFeature)
	Constructor without values. More...

	SketchAPI_EllipticArc (const std::shared_ptr< ModelAPI_Feature > &theFeature, double theCenterX, double theCenterY, double theFocusX, double theFocusY, double theStartX, double theStartY, double theEndX, double theEndY, bool theInversed)
	Constructor with values. More...

	SketchAPI_EllipticArc (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, const std::shared_ptr< GeomAPI_Pnt2d > &theFocus, const std::shared_ptr< GeomAPI_Pnt2d > &theStart, const std::shared_ptr< GeomAPI_Pnt2d > &theEnd, bool theInversed)
	Constructor with values. More...

	SketchAPI_EllipticArc (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theExternal)
	Constructor with external. More...

	SketchAPI_EllipticArc (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::wstring &theExternalName)
	Constructor with external. More...

virtual	~SketchAPI_EllipticArc ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< GeomDataAPI_Point2D >	center () const
	Center point. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	startPoint () const
	Start point of elliptic arc. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	endPoint () const
	End point of elliptic arc. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	reversed () const
	Inversed flag. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	firstFocus () const
	Focus in positive direction of a major axis. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	secondFocus () const
	Focus in negative direction of a major axis. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	majorAxisNegative () const
	Start point of major axis. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	majorAxisPositive () const
	End point of major axis. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	minorAxisNegative () const
	Start point of minor axis. More...

virtual std::shared_ptr< GeomDataAPI_Point2D >	minorAxisPositive () const
	End point of minor axis. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	majorRadius () const
	Major radius. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	minorRadius () const
	Minor radius. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	external () const
	External. More...

void	setByCenterFocusAndPoints (double theCenterX, double theCenterY, double theFocusX, double theFocusY, double theStartX, double theStartY, double theEndX, double theEndY, bool theInversed)
	Set by center, focus and radius. More...

void	setByCenterFocusAndPoints (const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, const std::shared_ptr< GeomAPI_Pnt2d > &theFocus, const std::shared_ptr< GeomAPI_Pnt2d > &theStart, const std::shared_ptr< GeomAPI_Pnt2d > &theEnd, bool theInversed)
	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...

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_AttributeBoolean >	auxiliary () const
	Auxiliary. More...

void	setAuxiliary (bool theAuxiliary)
	Set auxiliary. 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...

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

std::shared_ptr< GeomDataAPI_Point2D >	mystartPoint

std::shared_ptr< GeomDataAPI_Point2D >	myendPoint

std::shared_ptr< ModelAPI_AttributeBoolean >	myreversed

std::shared_ptr< GeomDataAPI_Point2D >	myfirstFocus

std::shared_ptr< GeomDataAPI_Point2D >	mysecondFocus

std::shared_ptr< GeomDataAPI_Point2D >	mymajorAxisNegative

std::shared_ptr< GeomDataAPI_Point2D >	mymajorAxisPositive

std::shared_ptr< GeomDataAPI_Point2D >	myminorAxisNegative

std::shared_ptr< GeomDataAPI_Point2D >	myminorAxisPositive

std::shared_ptr< ModelAPI_AttributeDouble >	mymajorRadius

std::shared_ptr< ModelAPI_AttributeDouble >	myminorRadius

std::shared_ptr< ModelAPI_AttributeSelection >	myexternal

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 Elliptic Arc feature.

Constructor & Destructor Documentation

◆ SketchAPI_EllipticArc() [1/5]

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

explicit

Constructor without values.

◆ SketchAPI_EllipticArc() [2/5]

SketchAPI_EllipticArc::SketchAPI_EllipticArc	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		double	theCenterX,
		double	theCenterY,
		double	theFocusX,
		double	theFocusY,
		double	theStartX,
		double	theStartY,
		double	theEndX,
		double	theEndY,
		bool	theInversed
	)

Constructor with values.

◆ SketchAPI_EllipticArc() [3/5]

SketchAPI_EllipticArc::SketchAPI_EllipticArc	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theCenter,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theFocus,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theStart,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theEnd,
		bool	theInversed
	)

Constructor with values.

◆ SketchAPI_EllipticArc() [4/5]

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

Constructor with external.

◆ SketchAPI_EllipticArc() [5/5]

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

Constructor with external.

◆ ~SketchAPI_EllipticArc()

SketchAPI_EllipticArc::~SketchAPI_EllipticArc ( )

virtual

Destructor.

Member Function Documentation

◆ center()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::center ( ) const

inlinevirtual

Center point.

◆ startPoint()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::startPoint ( ) const

inlinevirtual

Start point of elliptic arc.

◆ endPoint()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::endPoint ( ) const

inlinevirtual

End point of elliptic arc.

◆ reversed()

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

inlinevirtual

Inversed flag.

◆ firstFocus()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::firstFocus ( ) const

inlinevirtual

Focus in positive direction of a major axis.

◆ secondFocus()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::secondFocus ( ) const

inlinevirtual

Focus in negative direction of a major axis.

◆ majorAxisNegative()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::majorAxisNegative ( ) const

inlinevirtual

Start point of major axis.

◆ majorAxisPositive()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::majorAxisPositive ( ) const

inlinevirtual

End point of major axis.

◆ minorAxisNegative()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::minorAxisNegative ( ) const

inlinevirtual

Start point of minor axis.

◆ minorAxisPositive()

virtual std::shared_ptr< GeomDataAPI_Point2D > SketchAPI_EllipticArc::minorAxisPositive ( ) const

inlinevirtual

End point of minor axis.

◆ majorRadius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_EllipticArc::majorRadius ( ) const

inlinevirtual

Major radius.

◆ minorRadius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_EllipticArc::minorRadius ( ) const

inlinevirtual

Minor radius.

◆ external()

virtual std::shared_ptr< ModelAPI_AttributeSelection > SketchAPI_EllipticArc::external ( ) const

inlinevirtual

External.

◆ setByCenterFocusAndPoints() [1/2]

void SketchAPI_EllipticArc::setByCenterFocusAndPoints	(	double	theCenterX,
		double	theCenterY,
		double	theFocusX,
		double	theFocusY,
		double	theStartX,
		double	theStartY,
		double	theEndX,
		double	theEndY,
		bool	theInversed
	)

Set by center, focus and radius.

◆ setByCenterFocusAndPoints() [2/2]

void SketchAPI_EllipticArc::setByCenterFocusAndPoints	(	const std::shared_ptr< GeomAPI_Pnt2d > &	theCenter,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theFocus,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theStart,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theEnd,
		bool	theInversed
	)

Set by center, focus and radius.

◆ setByExternal()

void SketchAPI_EllipticArc::setByExternal ( const ModelHighAPI_Selection & theExternal )

Set by external.

◆ setByExternalName()

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

Set by external name.

◆ setCenter() [1/2]

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

Set center.

◆ setCenter() [2/2]

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

Set center.

◆ setFocus() [1/2]

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

Set focus.

◆ setFocus() [2/2]

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

Set focus.

◆ construction()

std::list< std::shared_ptr< SketchAPI_SketchEntity > > SketchAPI_EllipticArc::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_EllipticArc::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

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.

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_EllipticArc() [1/5]

◆ SketchAPI_EllipticArc() [2/5]

◆ SketchAPI_EllipticArc() [3/5]

◆ SketchAPI_EllipticArc() [4/5]

◆ SketchAPI_EllipticArc() [5/5]

◆ ~SketchAPI_EllipticArc()

Member Function Documentation

◆ center()

◆ startPoint()

◆ endPoint()

◆ reversed()

◆ firstFocus()

◆ secondFocus()

◆ majorAxisNegative()

◆ majorAxisPositive()

◆ minorAxisNegative()

◆ minorAxisPositive()

◆ majorRadius()

◆ minorRadius()

◆ external()

◆ setByCenterFocusAndPoints() [1/2]

◆ setByCenterFocusAndPoints() [2/2]

◆ setByExternal()

◆ setByExternalName()

◆ setCenter() [1/2]

◆ setCenter() [2/2]

◆ setFocus() [1/2]

◆ setFocus() [2/2]

◆ construction()

◆ dump()

◆ auxiliary()

◆ setAuxiliary()

◆ wrap()

◆ isCopy()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

Field Documentation

◆ myFeature

◆ myAttrGetter