Salome HOME
updated copyright message
[modules/shaper.git] / src / Selector / Selector_Intersect.h
1 // Copyright (C) 2014-2023  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 Selector_Intersect_H_
21 #define Selector_Intersect_H_
22
23 #include "Selector_AlgoWithSubs.h"
24
25 #include <list>
26
27 /**\class Selector_Intersect
28  * \ingroup DataModel
29  * \brief Kind of selection algorithm: sub-shape is intersection of higher level objects.
30  */
31 class Selector_Intersect: public Selector_AlgoWithSubs
32 {
33   TopAbs_ShapeEnum myShapeType; ///< type of this shape
34   int myWeakIndex; ///< weak index in case intersection produces several shapes
35   bool myRecomputeWeakIndex; ///< if the index is stored with old (unstable) order, recompute it
36 public:
37   /// Initializes the selection of this kind
38   SELECTOR_EXPORT bool select(const TopoDS_Shape theContext, const TopoDS_Shape theValue);
39
40   /// Stores the name to the label and sub-labels tree
41   SELECTOR_EXPORT virtual void store() override;
42
43   /// Restores the selected shape by the topological naming kept in the data structure
44   /// Returns true if it can restore structure correctly
45   SELECTOR_EXPORT virtual bool restore() override;
46
47   /// Restores the selected shape by the topological name string.
48   /// Returns not empty label of the context.
49   SELECTOR_EXPORT virtual TDF_Label restoreByName(std::wstring theName,
50     const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator* theNameGenerator) override;
51
52   /// Updates the current shape by the stored topological name
53   SELECTOR_EXPORT virtual bool solve(const TopoDS_Shape& theContext) override;
54
55   /// Returns the naming name of the selection
56   SELECTOR_EXPORT virtual std::wstring name(Selector_NameGenerator* theNameGenerator) override;
57 private:
58   /// Initializes selector
59   Selector_Intersect();
60
61   friend class Selector_Algo;
62 };
63
64 #endif