Interface for Circle feature. More...

Inheritance diagram for SketchAPI_Circle:

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

	SketchAPI_Circle (const std::shared_ptr< ModelAPI_Feature > &theFeature, double theCenterX, double theCenterY, double theRadius, bool theIsAddPoint=false, double theAngle=0.0)
	Constructor with values. More...

	SketchAPI_Circle (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, double theRadius, bool theIsAddPoint=false, double theAngle=0.0)
	Constructor with values. More...

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

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

virtual	~SketchAPI_Circle ()
	Destructor. More...

virtual std::string	getID ()

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

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

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

virtual std::shared_ptr< ModelAPI_AttributeDouble >	angle () const
	Angle. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	addpoint () const
	Is to add point. More...

void	setByCenterAndRadius (double theCenterX, double theCenterY, double theRadius, bool theIsAddPoint=false, double theAngle=0.0)
	Set by center and radius. More...

void	setByCenterAndRadius (const std::shared_ptr< GeomAPI_Pnt2d > &theCenter, double theRadius, bool theIsAddPoint=false, double theAngle=0.0)
	Set by center 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	setRadius (double theRadius)
	Set radius. More...

void	setAngle (double theAngle)
	Set angle. More...

void	setIsToAddPoint (bool theIsToAddPoint)
	Set is to add point. More...

std::shared_ptr< SketchAPI_SketchEntity >	createdPoint () const
	Returns created points on circle. 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...

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

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

Protected Attributes
std::shared_ptr< GeomDataAPI_Point2D >	mycenter

std::shared_ptr< ModelAPI_AttributeDouble >	myradius

std::shared_ptr< ModelAPI_AttributeSelection >	myexternal

std::shared_ptr< ModelAPI_AttributeDouble >	myangle

std::shared_ptr< ModelAPI_AttributeBoolean >	myaddpoint

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 Circle feature.

Constructor & Destructor Documentation

◆ SketchAPI_Circle() [1/5]

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

explicit

Constructor without values.

◆ SketchAPI_Circle() [2/5]

SketchAPI_Circle::SketchAPI_Circle	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		double	theCenterX,
		double	theCenterY,
		double	theRadius,
		bool	theIsAddPoint = `false`,
		double	theAngle = `0.0`
	)

Constructor with values.

◆ SketchAPI_Circle() [3/5]

SketchAPI_Circle::SketchAPI_Circle	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::shared_ptr< GeomAPI_Pnt2d > &	theCenter,
		double	theRadius,
		bool	theIsAddPoint = `false`,
		double	theAngle = `0.0`
	)

Constructor with values.

◆ SketchAPI_Circle() [4/5]

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

Constructor with values.

◆ SketchAPI_Circle() [5/5]

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

Constructor with values.

◆ ~SketchAPI_Circle()

SketchAPI_Circle::~SketchAPI_Circle ( )

virtual

Destructor.

Member Function Documentation

◆ center()

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

inlinevirtual

Center point.

◆ radius()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_Circle::radius ( ) const

inlinevirtual

Radius.

◆ external()

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

inlinevirtual

External.

◆ angle()

virtual std::shared_ptr< ModelAPI_AttributeDouble > SketchAPI_Circle::angle ( ) const

inlinevirtual

Angle.

◆ addpoint()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > SketchAPI_Circle::addpoint ( ) const

inlinevirtual

Is to add point.

◆ setByCenterAndRadius() [1/2]

void SketchAPI_Circle::setByCenterAndRadius	(	double	theCenterX,
		double	theCenterY,
		double	theRadius,
		bool	theIsAddPoint = `false`,
		double	theAngle = `0.0`
	)

Set by center and radius.

◆ setByCenterAndRadius() [2/2]

void SketchAPI_Circle::setByCenterAndRadius	(	const std::shared_ptr< GeomAPI_Pnt2d > &	theCenter,
		double	theRadius,
		bool	theIsAddPoint = `false`,
		double	theAngle = `0.0`
	)

Set by center and radius.

◆ setByExternal()

void SketchAPI_Circle::setByExternal ( const ModelHighAPI_Selection & theExternal )

Set by external.

◆ setByExternalName()

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

Set by external name.

◆ setCenter() [1/2]

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

Set center.

◆ setCenter() [2/2]

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

Set center.

◆ setRadius()

void SketchAPI_Circle::setRadius ( double theRadius )

Set radius.

◆ setAngle()

void SketchAPI_Circle::setAngle ( double theAngle )

Set angle.

◆ setIsToAddPoint()

void SketchAPI_Circle::setIsToAddPoint ( bool theIsToAddPoint )

Set is to add point.

◆ createdPoint()

std::shared_ptr< SketchAPI_SketchEntity > SketchAPI_Circle::createdPoint ( ) const

Returns created points on circle.

◆ dump()

void SketchAPI_Circle::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.

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

◆ SketchAPI_Circle() [2/5]

◆ SketchAPI_Circle() [3/5]

◆ SketchAPI_Circle() [4/5]

◆ SketchAPI_Circle() [5/5]

◆ ~SketchAPI_Circle()

Member Function Documentation

◆ center()

◆ radius()

◆ external()

◆ angle()

◆ addpoint()

◆ setByCenterAndRadius() [1/2]

◆ setByCenterAndRadius() [2/2]

◆ setByExternal()

◆ setByExternalName()

◆ setCenter() [1/2]

◆ setCenter() [2/2]

◆ setRadius()

◆ setAngle()

◆ setIsToAddPoint()

◆ createdPoint()

◆ dump()

◆ auxiliary()

◆ setAuxiliary()

◆ wrap()

◆ isCopy()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter