FiltersAPI_Selection Class Reference

Interface for the selection of filters. More...

Inheritance diagram for FiltersAPI_Selection:

Public Types
enum	VariantType {   VT_Empty , VT_ResultSubShapePair , VT_TypeSubShapeNamePair , VT_TypeInnerPointPair ,   VT_WeakNamingPair , VT_Filtering }

Public Member Functions
	FiltersAPI_Selection (const FiltersPtr &theFeature)
	Constructor without values. More...
virtual	~FiltersAPI_Selection ()
	Destructor. More...
FiltersFeaturePtr	feature () const
	Return filters feature. More...
std::list< ModelHighAPI_Selection >	select (const std::string theShapeType) const
	Return selected entities. More...
std::list< ModelHighAPI_Selection >	select (const GeomAPI_Shape::ShapeType theShapeType) const
virtual void	fillAttribute (const std::shared_ptr< ModelAPI_AttributeSelection > &theAttribute) const
	Fill attribute values. More...
virtual void	appendToList (const std::shared_ptr< ModelAPI_AttributeSelectionList > &theAttribute) const
	Append to list attribute. More...
virtual VariantType	variantType () const
virtual ResultSubShapePair	resultSubShapePair () const
virtual TypeSubShapeNamePair	typeSubShapeNamePair () const
virtual TypeInnerPointPair	typeInnerPointPair () const
virtual TypeWeakNamingPair	typeWeakNamingPair () const
virtual std::string	shapeType () const
void	setName (const std::wstring &theName)
	Shortcut for result()->data()->setName() More...
std::wstring	name () const
	Shortcut for result()->data()->name() More...
void	setColor (int theRed=0, int theGreen=0, int theBlue=0, bool random=false)
	Change result's color. More...
void	setSubShapeColor (const ModelHighAPI_Selection &theShape, int theRed, int theGreen, int theBlue)
	Change subShape' color. More...
std::list< int >	getSubShapeColor (const ModelHighAPI_Selection &theShape)
	Get subShape' color. More...
void	setDeflection (double theValue)
	Change result's deflection. More...
void	setTransparency (double theValue)
	Change result's transparency. More...
int	numberOfSubs () const
	Returns the number of sub-elements. More...
ModelHighAPI_Selection	subResult (int theIndex) const
	Returns the sub-result by zero-base index. More...

Protected Attributes
VariantType	myVariantType
ResultSubShapePair	myResultSubShapePair
TypeSubShapeNamePair	myTypeSubShapeNamePair
TypeInnerPointPair	myTypeInnerPointPair
TypeWeakNamingPair	myWeakNamingPair
std::shared_ptr< ModelAPI_FiltersFeature >	myFilterFeature

Detailed Description

Interface for the selection of filters.

Constructor & Destructor Documentation

FiltersAPI_Selection()

FiltersAPI_Selection::FiltersAPI_Selection ( const FiltersPtr &  theFeature )

explicit

Constructor without values.

~FiltersAPI_Selection()

FiltersAPI_Selection::~FiltersAPI_Selection ( )

virtual

Destructor.

Member Function Documentation

feature()

FiltersFeaturePtr FiltersAPI_Selection::feature

(

)

const

Return filters feature.

select()

std::list< ModelHighAPI_Selection > FiltersAPI_Selection::select

(

const std::string

theShapeType

)

const

Return selected entities.

fillAttribute()

void ModelHighAPI_Selection::fillAttribute ( const std::shared_ptr< ModelAPI_AttributeSelection > &  theAttribute ) const

virtualinherited

Fill attribute values.

appendToList()

void ModelHighAPI_Selection::appendToList ( const std::shared_ptr< ModelAPI_AttributeSelectionList > &  theAttribute ) const

virtualinherited

Append to list attribute.

variantType()

ModelHighAPI_Selection::VariantType ModelHighAPI_Selection::variantType ( ) const

virtualinherited

Returns

variant type.

resultSubShapePair()

ResultSubShapePair ModelHighAPI_Selection::resultSubShapePair ( ) const

virtualinherited

Returns

pair of result and sub-shape.

typeSubShapeNamePair()

TypeSubShapeNamePair ModelHighAPI_Selection::typeSubShapeNamePair ( ) const

virtualinherited

Returns

pair of sub-shape type and name.

typeInnerPointPair()

TypeInnerPointPair ModelHighAPI_Selection::typeInnerPointPair ( ) const

virtualinherited

Returns

pair of sub-shape type and inner point to identify sub-shape.

typeWeakNamingPair()

TypeWeakNamingPair ModelHighAPI_Selection::typeWeakNamingPair ( ) const

virtualinherited

Returns

pair of sub-shape type and pair of context name and sub-shape index.

shapeType()

std::string ModelHighAPI_Selection::shapeType ( ) const

virtualinherited

Returns

shape type.

setName()

void ModelHighAPI_Selection::setName ( const std::wstring &  theName )

inherited

Shortcut for result()->data()->setName()

name()

std::wstring ModelHighAPI_Selection::name ( ) const

inherited

Shortcut for result()->data()->name()

setColor()

void ModelHighAPI_Selection::setColor ( int  theRed = 0, int  theGreen = 0, int  theBlue = 0, bool  random = false  )

inherited

Change result's color.

setSubShapeColor()

void ModelHighAPI_Selection::setSubShapeColor ( const ModelHighAPI_Selection &  theShape, int  theRed, int  theGreen, int  theBlue  )

inherited

Change subShape' color.

getSubShapeColor()

std::list< int > ModelHighAPI_Selection::getSubShapeColor ( const ModelHighAPI_Selection &  theShape )

inherited

Get subShape' color.

setDeflection()

void ModelHighAPI_Selection::setDeflection ( double  theValue )

inherited

Change result's deflection.

setTransparency()

void ModelHighAPI_Selection::setTransparency ( double  theValue )

inherited

Change result's transparency.

numberOfSubs()

int ModelHighAPI_Selection::numberOfSubs ( ) const

inherited

Returns the number of sub-elements.

subResult()

ModelHighAPI_Selection ModelHighAPI_Selection::subResult ( int  theIndex ) const

inherited

Returns the sub-result by zero-base index.