Interface for Projection feature. More...

Inheritance diagram for SketchAPI_Projection:

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

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

virtual	~SketchAPI_Projection ()
	Destructor. More...

virtual std::string	getID ()

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

virtual std::shared_ptr< ModelAPI_AttributeRefAttr >	projectedFeature () const
	Projected feature. More...

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

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	includeToResult () const
	Include into result. More...

void	setExternalFeature (const ModelHighAPI_Selection &theExternalLine)
	Set external feature. More...

void	setIncludeToResult (bool theKeepResult)
	Set flag to include projection to result or not. More...

void	setKeepReferenceToOriginal (bool theKeepRefToOriginal)
	Set flag to keep the reference to the original shape. More...

std::shared_ptr< SketchAPI_SketchEntity >	createdFeature () const
	Returns created feature. 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< ModelAPI_AttributeSelection >	myexternalFeature

std::shared_ptr< ModelAPI_AttributeRefAttr >	myprojectedFeature

std::shared_ptr< ModelAPI_AttributeSelection >	myexternal

std::shared_ptr< ModelAPI_AttributeBoolean >	myincludeToResult

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

Constructor & Destructor Documentation

◆ SketchAPI_Projection() [1/2]

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

explicit

Constructor without values.

◆ SketchAPI_Projection() [2/2]

SketchAPI_Projection::SketchAPI_Projection	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theExternalFeature
	)

Constructor with values.

◆ ~SketchAPI_Projection()

SketchAPI_Projection::~SketchAPI_Projection ( )

virtual

Destructor.

Member Function Documentation

◆ externalFeature()

virtual std::shared_ptr< ModelAPI_AttributeSelection > SketchAPI_Projection::externalFeature ( ) const

inlinevirtual

External feature.

◆ projectedFeature()

virtual std::shared_ptr< ModelAPI_AttributeRefAttr > SketchAPI_Projection::projectedFeature ( ) const

inlinevirtual

Projected feature.

◆ external()

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

inlinevirtual

External.

◆ includeToResult()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > SketchAPI_Projection::includeToResult ( ) const

inlinevirtual

Include into result.

◆ setExternalFeature()

void SketchAPI_Projection::setExternalFeature ( const ModelHighAPI_Selection & theExternalLine )

Set external feature.

◆ setIncludeToResult()

void SketchAPI_Projection::setIncludeToResult ( bool theKeepResult )

Set flag to include projection to result or not.

◆ setKeepReferenceToOriginal()

void SketchAPI_Projection::setKeepReferenceToOriginal ( bool theKeepRefToOriginal )

Set flag to keep the reference to the original shape.

◆ createdFeature()

std::shared_ptr< SketchAPI_SketchEntity > SketchAPI_Projection::createdFeature ( ) const

Returns created feature.

◆ dump()

void SketchAPI_Projection::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_Projection() [1/2]

◆ SketchAPI_Projection() [2/2]

◆ ~SketchAPI_Projection()

Member Function Documentation

◆ externalFeature()

◆ projectedFeature()

◆ external()

◆ includeToResult()

◆ setExternalFeature()

◆ setIncludeToResult()

◆ setKeepReferenceToOriginal()

◆ createdFeature()

◆ dump()

◆ auxiliary()

◆ setAuxiliary()

◆ wrap()

◆ isCopy()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

Field Documentation

◆ myFeature

◆ myAttrGetter