Interface for ExtrusionBoolean feature. More...

Inheritance diagram for FeaturesAPI_ExtrusionBoolean:

Public Member Functions
virtual	~FeaturesAPI_ExtrusionBoolean ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< ModelAPI_AttributeReference >	sketch () const
	Sketch launcher. More...

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

virtual std::shared_ptr< ModelAPI_AttributeSelection >	direction () const
	Direction. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	creationMethod () const
	Creation method. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	toSize () const
	To size. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	fromSize () const
	From size. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	toObject () const
	To object. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	toOffset () const
	To offset. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	fromObject () const
	From object. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	fromOffset () const
	From offset. More...

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

void	setNestedSketch (const ModelHighAPI_Reference &theSketch)
	Modify base attribute of the feature. More...

void	setBase (const std::list< ModelHighAPI_Selection > &theBaseObjects)
	Modify base attribute of the feature. More...

void	setDirection (const ModelHighAPI_Selection &theDirection)
	Modify direction_object attribute of the feature. More...

void	setSizes (const ModelHighAPI_Double &theToSize, const ModelHighAPI_Double &theFromSize)
	Modify CreationMethod, to_size, from_size attributes of the feature. More...

void	setSize (const ModelHighAPI_Double &theSize)
	Modify creation_method, to_size, from_size attributes of the feature. More...

void	setPlanesAndOffsets (const ModelHighAPI_Selection &theToObject, const ModelHighAPI_Double &theToOffset, const ModelHighAPI_Selection &theFromObject, const ModelHighAPI_Double &theFromOffset)
	Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature. More...

void	setBooleanObjects (const std::list< ModelHighAPI_Selection > &theBooleanObjects)
	Modiyfy main_objects attribute of the feature. 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 ()

	FeaturesAPI_ExtrusionBoolean (const std::shared_ptr< ModelAPI_Feature > &theFeature)
	Constructor without values. More...

Protected Attributes
std::shared_ptr< ModelAPI_AttributeReference >	mysketch

std::shared_ptr< ModelAPI_AttributeSelectionList >	mybaseObjects

std::shared_ptr< ModelAPI_AttributeSelection >	mydirection

std::shared_ptr< ModelAPI_AttributeString >	mycreationMethod

std::shared_ptr< ModelAPI_AttributeDouble >	mytoSize

std::shared_ptr< ModelAPI_AttributeDouble >	myfromSize

std::shared_ptr< ModelAPI_AttributeSelection >	mytoObject

std::shared_ptr< ModelAPI_AttributeDouble >	mytoOffset

std::shared_ptr< ModelAPI_AttributeSelection >	myfromObject

std::shared_ptr< ModelAPI_AttributeDouble >	myfromOffset

std::shared_ptr< ModelAPI_AttributeSelectionList >	mybooleanObjects

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

Constructor & Destructor Documentation

◆ ~FeaturesAPI_ExtrusionBoolean()

FeaturesAPI_ExtrusionBoolean::~FeaturesAPI_ExtrusionBoolean ( )

virtual

Destructor.

◆ FeaturesAPI_ExtrusionBoolean()

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

explicitprotected

Constructor without values.

Member Function Documentation

◆ sketch()

virtual std::shared_ptr< ModelAPI_AttributeReference > FeaturesAPI_ExtrusionBoolean::sketch ( ) const

inlinevirtual

Sketch launcher.

◆ baseObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_ExtrusionBoolean::baseObjects ( ) const

inlinevirtual

Base objects.

◆ direction()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_ExtrusionBoolean::direction ( ) const

inlinevirtual

Direction.

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > FeaturesAPI_ExtrusionBoolean::creationMethod ( ) const

inlinevirtual

Creation method.

◆ toSize()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_ExtrusionBoolean::toSize ( ) const

inlinevirtual

To size.

◆ fromSize()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_ExtrusionBoolean::fromSize ( ) const

inlinevirtual

From size.

◆ toObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_ExtrusionBoolean::toObject ( ) const

inlinevirtual

To object.

◆ toOffset()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_ExtrusionBoolean::toOffset ( ) const

inlinevirtual

To offset.

◆ fromObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_ExtrusionBoolean::fromObject ( ) const

inlinevirtual

From object.

◆ fromOffset()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_ExtrusionBoolean::fromOffset ( ) const

inlinevirtual

From offset.

◆ booleanObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_ExtrusionBoolean::booleanObjects ( ) const

inlinevirtual

Boolean objects.

◆ setNestedSketch()

void FeaturesAPI_ExtrusionBoolean::setNestedSketch ( const ModelHighAPI_Reference & theSketch )

Modify base attribute of the feature.

◆ setBase()

void FeaturesAPI_ExtrusionBoolean::setBase ( const std::list< ModelHighAPI_Selection > & theBaseObjects )

Modify base attribute of the feature.

◆ setDirection()

void FeaturesAPI_ExtrusionBoolean::setDirection ( const ModelHighAPI_Selection & theDirection )

Modify direction_object attribute of the feature.

◆ setSizes()

void FeaturesAPI_ExtrusionBoolean::setSizes	(	const ModelHighAPI_Double &	theToSize,
		const ModelHighAPI_Double &	theFromSize
	)

Modify CreationMethod, to_size, from_size attributes of the feature.

◆ setSize()

void FeaturesAPI_ExtrusionBoolean::setSize ( const ModelHighAPI_Double & theSize )

Modify creation_method, to_size, from_size attributes of the feature.

◆ setPlanesAndOffsets()

void FeaturesAPI_ExtrusionBoolean::setPlanesAndOffsets	(	const ModelHighAPI_Selection &	theToObject,
		const ModelHighAPI_Double &	theToOffset,
		const ModelHighAPI_Selection &	theFromObject,
		const ModelHighAPI_Double &	theFromOffset
	)

Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.

◆ setBooleanObjects()

void FeaturesAPI_ExtrusionBoolean::setBooleanObjects ( const std::list< ModelHighAPI_Selection > & theBooleanObjects )

Modiyfy main_objects attribute of the feature.

◆ dump()

void FeaturesAPI_ExtrusionBoolean::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_ExtrusionBoolean()

◆ FeaturesAPI_ExtrusionBoolean()

Member Function Documentation

◆ sketch()

◆ baseObjects()

◆ direction()

◆ creationMethod()

◆ toSize()

◆ fromSize()

◆ toObject()

◆ toOffset()

◆ fromObject()

◆ fromOffset()

◆ booleanObjects()

◆ setNestedSketch()

◆ setBase()

◆ setDirection()

◆ setSizes()

◆ setSize()

◆ setPlanesAndOffsets()

◆ setBooleanObjects()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter