SHAPER 9.16.0
FiltersPlugin_OnLine.h
1// Copyright (C) 2014-2026 CEA, EDF
2//
3// This library is free software; you can redistribute it and/or
4// modify it under the terms of the GNU Lesser General Public
5// License as published by the Free Software Foundation; either
6// version 2.1 of the License, or (at your option) any later version.
7//
8// This library is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11// Lesser General Public License for more details.
12//
13// You should have received a copy of the GNU Lesser General Public
14// License along with this library; if not, write to the Free Software
15// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16//
17// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18//
19
20#ifndef FILTERSPLUGIN_ONLINE_H_
21#define FILTERSPLUGIN_ONLINE_H_
22
23#include "FiltersPlugin.h"
24
25#include <ModelAPI_Filter.h>
26
32{
33public:
35
36 virtual const std::string& name() const {
37 static const std::string kName("On line");
38 return kName;
39 }
40
42 virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override;
43
45 virtual bool isMultiple() const { return true; }
46
51 virtual bool isOk(const GeomShapePtr& theShape, const ResultPtr&,
52 const ModelAPI_FiltersArgs& theArgs) const override;
53
55 virtual std::string xmlRepresentation() const override;
56
58 virtual void initAttributes(ModelAPI_FiltersArgs& theArguments) override;
59};
60
61#endif
Filter for objects which belong to selected lines.
Definition: FiltersPlugin_OnLine.h:32
virtual const std::string & name() const
Returns name of the filter to represent it in GUI.
Definition: FiltersPlugin_OnLine.h:36
virtual std::string xmlRepresentation() const override
Returns XML string which represents GUI of the filter.
Definition: FiltersPlugin_OnLine.cpp:85
virtual void initAttributes(ModelAPI_FiltersArgs &theArguments) override
Initializes arguments of a filter.
Definition: FiltersPlugin_OnLine.cpp:90
virtual bool isMultiple() const
Returns True if the filter can be used several times within one selection.
Definition: FiltersPlugin_OnLine.h:45
virtual bool isOk(const GeomShapePtr &theShape, const ResultPtr &, const ModelAPI_FiltersArgs &theArgs) const override
This method should contain the filter logic.
Definition: FiltersPlugin_OnLine.cpp:52
virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override
Returns true for any type because it supports all selection types.
Definition: FiltersPlugin_OnLine.cpp:47
ShapeType
Shape type enum.
Definition: GeomAPI_Shape.h:46
Definition: ModelAPI_Filter.h:34
definition of arguments of filters: id of the argument to attributes
Definition: ModelAPI_FiltersArgs.h:31