SHAPER 9.16.0
FiltersPlugin_Selection.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_SELECTION_H_
21#define FILTERSPLUGIN_SELECTION_H_
22
23#include "FiltersPlugin.h"
24#include <ModelAPI_FiltersFeature.h>
25
32{
33public:
35 inline static const std::string& ID() {
36 static const std::string MY_GROUP_ID("FiltersSelection");
37 return MY_GROUP_ID;
38 }
39
41 FILTERS_EXPORT virtual const std::string& getKind() {
42 return ID();
43 }
44
46 virtual bool isInHistory() {
47 return false;
48 }
49
51 FILTERS_EXPORT virtual void execute() {}
52
55
57 FILTERS_EXPORT virtual void initAttributes() override;
58
59 // methods related to the filters management
60
63 FILTERS_EXPORT virtual std::string addFilter(const std::string theFilterID) override;
64
66 FILTERS_EXPORT virtual void removeFilter(const std::string theFilterID) override;
67
69 FILTERS_EXPORT virtual std::list<std::string> filters() const override;
70
72 FILTERS_EXPORT virtual void setReversed
73 (const std::string theFilterID, const bool theReversed) override;
74
76 FILTERS_EXPORT virtual bool isReversed(const std::string theFilterID) override;
77
79 FILTERS_EXPORT virtual std::list<AttributePtr>
80 filterArgs(const std::string theFilterID) const override;
81
84 FILTERS_EXPORT virtual void setAttribute(const AttributePtr& theAttr) override;
85
87 FILTERS_EXPORT virtual const AttributePtr& baseAttribute() const override;
88
89protected:
90
91 AttributePtr myBase;
92};
93
94#endif
An interface for working with filters in the feature.
Definition: FiltersPlugin_Selection.h:32
virtual std::string addFilter(const std::string theFilterID) override
Adds a filter to the feature.
Definition: FiltersPlugin_Selection.cpp:31
virtual void removeFilter(const std::string theFilterID) override
Removes an existing filter from the feature.
Definition: FiltersPlugin_Selection.cpp:70
virtual std::list< AttributePtr > filterArgs(const std::string theFilterID) const override
Returns the ordered list of attributes related to the filter.
Definition: FiltersPlugin_Selection.cpp:103
virtual bool isReversed(const std::string theFilterID) override
Returns the reversed flag value for the filter.
Definition: FiltersPlugin_Selection.cpp:94
FiltersPlugin_Selection()
Feature is created in the plugin manager.
Definition: FiltersPlugin_Selection.h:54
AttributePtr myBase
the attribute related to this filter
Definition: FiltersPlugin_Selection.h:91
virtual void setReversed(const std::string theFilterID, const bool theReversed) override
Stores the reversed flag for the filter.
Definition: FiltersPlugin_Selection.cpp:86
virtual const std::string & getKind()
Returns the kind of a feature.
Definition: FiltersPlugin_Selection.h:41
virtual void execute()
Computes a selection?
Definition: FiltersPlugin_Selection.h:51
static const std::string & ID()
Extrusion kind.
Definition: FiltersPlugin_Selection.h:35
virtual bool isInHistory()
This feature does not displayed in the data tree.
Definition: FiltersPlugin_Selection.h:46
virtual const AttributePtr & baseAttribute() const override
Returns the attribute (not-persistent field) that contains this filters feature.
Definition: FiltersPlugin_Selection.cpp:133
virtual void setAttribute(const AttributePtr &theAttr) override
Sets the attribute (not-persistent field) that contains this filters feature.
Definition: FiltersPlugin_Selection.cpp:110
virtual void initAttributes() override
This method initializes all filters on open of document.
Definition: FiltersPlugin_Selection.cpp:138
virtual std::list< std::string > filters() const override
Returns the list of existing filters in the feature.
Definition: FiltersPlugin_Selection.cpp:79
An interface for working with filters in the feature.
Definition: ModelAPI_FiltersFeature.h:33