SHAPER  9.12.0
FiltersPlugin_HorizontalFace Class Reference

Filter for horizontal faces only. More...

Inheritance diagram for FiltersPlugin_HorizontalFace:
Inheritance graph

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 horizontal faces only.

Member Function Documentation

◆ name()

virtual const std::string& FiltersPlugin_HorizontalFace::name ( ) const
inlinevirtual

Returns name of the filter to represent it in GUI.

Implements ModelAPI_Filter.

◆ isSupported()

bool FiltersPlugin_HorizontalFace::isSupported ( GeomAPI_Shape::ShapeType  theType) const
overridevirtual

Returns true if the given shape type is supported.

Implements ModelAPI_Filter.

◆ isOk()

bool FiltersPlugin_HorizontalFace::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
theShapethe given shape
theArgsarguments 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

◆ initAttributes()

◆ 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.