FiltersPlugin_VerticalFace Class Reference

Filter for vertical faces only. More...

Inheritance diagram for FiltersPlugin_VerticalFace:

Public Member Functions
virtual const std::string &	name () const
	Returns name of the filter to represent it in GUI. More...
virtual bool	isSupported (GeomAPI_Shape::ShapeType theType) const override
	Returns true if the given shape type is supported. More...
virtual bool	isOk (const GeomShapePtr &theShape, const ResultPtr &, const ModelAPI_FiltersArgs &theArgs) const override
	This method should contain the filter logic. More...
virtual bool	isMultiple () const
	Returns True if the filter can be used several times within one filtering. More...
virtual std::string	xmlRepresentation () const
	Returns XML string which represents GUI of the filter By default it returns nothing (no GUI) More...
virtual void	initAttributes (ModelAPI_FiltersArgs &)
	Initializes arguments of a filter. More...
virtual std::string	xmlFromFile (const std::string &theConfigFile) const
	Returns XML string which represents GUI of the filter by reading corresponding XML file. More...

Detailed Description

Filter for vertical faces only.

Member Function Documentation

name()

virtual const std::string& FiltersPlugin_VerticalFace::name ( ) const

inlinevirtual

Returns name of the filter to represent it in GUI.

Implements ModelAPI_Filter.

isSupported()

bool FiltersPlugin_VerticalFace::isSupported ( GeomAPI_Shape::ShapeType  theType ) const

overridevirtual

Returns true if the given shape type is supported.

Implements ModelAPI_Filter.

isOk()

bool FiltersPlugin_VerticalFace::isOk ( const GeomShapePtr &  theShape, const ResultPtr &  , const ModelAPI_FiltersArgs &  theArgs  ) const

overridevirtual

This method should contain the filter logic.

It returns true if the given shape is accepted by the filter.

Parameters

theShape	the given shape
theArgs	arguments of the filter

Implements ModelAPI_Filter.

isMultiple()

virtual bool ModelAPI_Filter::isMultiple ( ) const

inlinevirtualinherited

Returns True if the filter can be used several times within one filtering.

Reimplemented in FiltersPlugin_RelativeToSolid, FiltersPlugin_OnPlaneSide, FiltersPlugin_OnPlane, and FiltersPlugin_OnLine.

xmlRepresentation()

virtual std::string ModelAPI_Filter::xmlRepresentation ( ) const

inlinevirtualinherited

Returns XML string which represents GUI of the filter By default it returns nothing (no GUI)

Reimplemented in FiltersPlugin_VolumeSize, FiltersPlugin_RelativeToSolid, FiltersPlugin_OppositeToEdge, FiltersPlugin_OnShapeName, FiltersPlugin_OnPlaneSide, FiltersPlugin_OnPlane, FiltersPlugin_OnLine, FiltersPlugin_OnGeometry, FiltersPlugin_FeatureEdges, FiltersPlugin_FaceSize, FiltersPlugin_EdgeSize, FiltersPlugin_ContinuousFaces, and FiltersPlugin_BelongsTo.

initAttributes()

virtual void ModelAPI_Filter::initAttributes ( ModelAPI_FiltersArgs &  )

inlinevirtualinherited

Initializes arguments of a filter.

If a filter has no arguments, this method may be not redefined.

Reimplemented in FiltersPlugin_VolumeSize, FiltersPlugin_RelativeToSolid, FiltersPlugin_OppositeToEdge, FiltersPlugin_OnShapeName, FiltersPlugin_OnPlaneSide, FiltersPlugin_OnPlane, FiltersPlugin_OnLine, FiltersPlugin_OnGeometry, FiltersPlugin_FeatureEdges, FiltersPlugin_FaceSize, FiltersPlugin_EdgeSize, FiltersPlugin_ContinuousFaces, and FiltersPlugin_BelongsTo.

xmlFromFile()

std::string ModelAPI_Filter::xmlFromFile ( const std::string &  theConfigFile ) const

virtualinherited

Returns XML string which represents GUI of the filter by reading corresponding XML file.