1 // Copyright (C) 2014-2020 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef FILTERSPLUGIN_RELATIVETOSOLID_H_
21 #define FILTERSPLUGIN_RELATIVETOSOLID_H_
23 #include "FiltersPlugin.h"
25 #include <ModelAPI_Filter.h>
27 /**\class FiltersPlugin_RelativeToSolid
29 * \brief Filter for objects inside/outside/on the selected solid
31 class FiltersPlugin_RelativeToSolid : public ModelAPI_Filter
34 FiltersPlugin_RelativeToSolid() : ModelAPI_Filter() {}
36 virtual const std::string& name() const {
37 static const std::string kName("On/In/Out a solid");
41 /// Returns true for any type because it supports all selection types
42 virtual bool isSupported(GeomAPI_Shape::ShapeType theType) const override;
44 /// Returns True if the filter can be used several times within one selection
45 virtual bool isMultiple() const { return true; }
47 /// This method should contain the filter logic. It returns true if the given shape
48 /// is accepted by the filter.
49 /// \param theShape the given shape
50 /// \param theArgs arguments of the filter
51 virtual bool isOk(const GeomShapePtr& theShape, const ResultPtr&,
52 const ModelAPI_FiltersArgs& theArgs) const override;
54 /// Returns XML string which represents GUI of the filter
55 virtual std::string xmlRepresentation() const override;
57 /// Initializes arguments of a filter.
58 virtual void initAttributes(ModelAPI_FiltersArgs& theArguments) override;