1 // Copyright (C) 2014-2022 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 Selector_FilterByNeighbors_H_
21 #define Selector_FilterByNeighbors_H_
23 #include "Selector_AlgoWithSubs.h"
27 /**\class Selector_FilterByNeighbors
29 * \brief Kind of selection algorithm: selected shape is identified by neighbor faces of
30 * the same type. Or neighbors of neighbors are considered, etc.
31 * be named one by one.
33 class Selector_FilterByNeighbors: public Selector_AlgoWithSubs
35 TopAbs_ShapeEnum myShapeType; ///< type of this shape
36 std::list<int> myNBLevel; ///< list of integers corresponding to subs neighborhood level
37 TDF_Label myContext; ///< label where the context of filter is stored (for naming name strings)
39 /// Initializes the selection of this kind
40 SELECTOR_EXPORT bool select(
41 const TDF_Label theContextLab, const TopoDS_Shape theContext, const TopoDS_Shape theValue);
43 /// Stores the name to the label and sub-labels tree
44 SELECTOR_EXPORT virtual void store() override;
46 /// Restores the selected shape by the topological naming kept in the data structure
47 /// Returns true if it can restore structure correctly
48 SELECTOR_EXPORT virtual bool restore() override;
50 /// Restores the selected shape by the topological name string.
51 /// Returns not empty label of the context.
52 SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
53 const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) override;
55 /// Updates the current shape by the stored topological name
56 SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) override;
58 /// Returns the naming name of the selection
59 SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) override;
61 /// Initializes selector
62 Selector_FilterByNeighbors();
64 friend class Selector_Algo;