SHAPER  9.12.0
FiltersPlugin_RelativeToSolid Class Reference

Filter for objects inside/outside/on the selected solid. More...

Inheritance diagram for FiltersPlugin_RelativeToSolid:
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 for any type because it supports all selection types. More...
 
virtual bool isMultiple () const
 Returns True if the filter can be used several times within one selection. More...
 
virtual bool isOk (const GeomShapePtr &theShape, const ResultPtr &, const ModelAPI_FiltersArgs &theArgs) const override
 This method should contain the filter logic. More...
 
virtual std::string xmlRepresentation () const override
 Returns XML string which represents GUI of the filter. More...
 
virtual void initAttributes (ModelAPI_FiltersArgs &theArguments) override
 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 objects inside/outside/on the selected solid.

Member Function Documentation

◆ name()

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

Returns name of the filter to represent it in GUI.

Implements ModelAPI_Filter.

◆ isSupported()

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

Returns true for any type because it supports all selection types.

Implements ModelAPI_Filter.

◆ isMultiple()

virtual bool FiltersPlugin_RelativeToSolid::isMultiple ( ) const
inlinevirtual

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

Reimplemented from ModelAPI_Filter.

◆ isOk()

bool FiltersPlugin_RelativeToSolid::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.

◆ xmlRepresentation()

std::string FiltersPlugin_RelativeToSolid::xmlRepresentation ( ) const
overridevirtual

Returns XML string which represents GUI of the filter.

Reimplemented from ModelAPI_Filter.

◆ initAttributes()

void FiltersPlugin_RelativeToSolid::initAttributes ( ModelAPI_FiltersArgs theArguments)
overridevirtual

Initializes arguments of a filter.

Reimplemented from ModelAPI_Filter.

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