Interface for Placement feature. More...

Inheritance diagram for FeaturesAPI_Placement:

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

	FeaturesAPI_Placement (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theObjects, const ModelHighAPI_Selection &theStartShape, const ModelHighAPI_Selection &theEndShape, const bool theReverseDirection=false, const bool theCentering=false)
	Constructor with values. More...

virtual	~FeaturesAPI_Placement ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList >	objects () const
	Main objects. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	startShape () const
	Start shape. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	endShape () const
	End shape. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	reverseDirection () const
	Reverse direction flag. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	centering () const
	Centering flag. More...

void	setObjects (const std::list< ModelHighAPI_Selection > &theObjects)
	Set objects. More...

void	setStartShape (const ModelHighAPI_Selection &theStartShape)
	Set start shape. More...

void	setEndShape (const ModelHighAPI_Selection &theEndShape)
	Set end shape. More...

void	setReverseDirection (const bool theReverseDirection)
	Set reverse direction flag. More...

void	setCentering (const bool theCentering)
	Set centering flag. 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 ()

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeSelectionList >	myobjects

std::shared_ptr< ModelAPI_AttributeSelection >	mystartShape

std::shared_ptr< ModelAPI_AttributeSelection >	myendShape

std::shared_ptr< ModelAPI_AttributeBoolean >	myreverseDirection

std::shared_ptr< ModelAPI_AttributeBoolean >	mycentering

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

Constructor & Destructor Documentation

◆ FeaturesAPI_Placement() [1/2]

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

explicit

Constructor without values.

◆ FeaturesAPI_Placement() [2/2]

FeaturesAPI_Placement::FeaturesAPI_Placement	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theObjects,
		const ModelHighAPI_Selection &	theStartShape,
		const ModelHighAPI_Selection &	theEndShape,
		const bool	theReverseDirection = `false`,
		const bool	theCentering = `false`
	)

Constructor with values.

◆ ~FeaturesAPI_Placement()

FeaturesAPI_Placement::~FeaturesAPI_Placement ( )

virtual

Destructor.

Member Function Documentation

◆ objects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_Placement::objects ( ) const

inlinevirtual

Main objects.

◆ startShape()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Placement::startShape ( ) const

inlinevirtual

Start shape.

◆ endShape()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Placement::endShape ( ) const

inlinevirtual

End shape.

◆ reverseDirection()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > FeaturesAPI_Placement::reverseDirection ( ) const

inlinevirtual

Reverse direction flag.

◆ centering()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > FeaturesAPI_Placement::centering ( ) const

inlinevirtual

Centering flag.

◆ setObjects()

void FeaturesAPI_Placement::setObjects ( const std::list< ModelHighAPI_Selection > & theObjects )

Set objects.

◆ setStartShape()

void FeaturesAPI_Placement::setStartShape ( const ModelHighAPI_Selection & theStartShape )

Set start shape.

◆ setEndShape()

void FeaturesAPI_Placement::setEndShape ( const ModelHighAPI_Selection & theEndShape )

Set end shape.

◆ setReverseDirection()

void FeaturesAPI_Placement::setReverseDirection ( const bool theReverseDirection )

Set reverse direction flag.

◆ setCentering()

void FeaturesAPI_Placement::setCentering ( const bool theCentering )

Set centering flag.

◆ dump()

void FeaturesAPI_Placement::dump ( ModelHighAPI_Dumper & theDumper ) const

virtual

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ 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

◆ FeaturesAPI_Placement() [1/2]

◆ FeaturesAPI_Placement() [2/2]

◆ ~FeaturesAPI_Placement()

Member Function Documentation

◆ objects()

◆ startShape()

◆ endShape()

◆ reverseDirection()

◆ centering()

◆ setObjects()

◆ setStartShape()

◆ setEndShape()

◆ setReverseDirection()

◆ setCentering()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter