1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef Selector_Selector_H_
22 #define Selector_Selector_H_
26 #include <TDF_Label.hxx>
27 #include <TopoDS_Shape.hxx>
29 class Selector_NameGenerator;
32 /**\class Selector_Selector
34 * \brief Main object for selection of the sub-shapes in the parametrically updated
35 * shapes using topological naming mechanism.
37 class Selector_Selector
39 TDF_Label myLab; ///< main label where selector is performed
40 TDF_Label myBaseDocumentLab; ///< an access-label to the document that may contain initial shapes
41 Selector_Algo* myAlgo; ///< root algorithm of the selector
44 /// Initializes selector on the label
45 SELECTOR_EXPORT Selector_Selector(TDF_Label theLab, TDF_Label theBaseDocLab = TDF_Label());
48 SELECTOR_EXPORT ~Selector_Selector();
50 /// Initializes the selector structure on the label.
51 /// Stores the name data to restore after modification.
52 /// \param theContext whole shape that contains the selected sub-shape
53 /// \param theValue selected subshape
54 /// \param theGeometricalNaming treats selection with equal surfaces as one
55 /// \param theUseNeighbors enables searching algorithm by neighbors
56 /// \param theUseIntersections enables searching algorithm by intersection of higher level shapes
57 SELECTOR_EXPORT bool select(const TopoDS_Shape theContext, const TopoDS_Shape theValue,
58 const bool theGeometricalNaming = false);
60 /// Stores the name to the label and sub-labels tree
61 SELECTOR_EXPORT bool store(const TopoDS_Shape theContext);
63 /// Restores the selected shape by the topological naming kept in the data structure
64 /// Returns true if it can restore structure correctly
65 SELECTOR_EXPORT bool restore(const TopoDS_Shape theContext);
67 /// Restores the selected shape by the topological name string.
68 /// Returns not empty label of the context.
69 SELECTOR_EXPORT TDF_Label restoreByName(
70 std::string theName, const TopAbs_ShapeEnum theShapeType,
71 Selector_NameGenerator* theNameGenerator, const bool theGeometricalNaming = false);
73 /// Returns the current sub-shape value (null if can not resolve)
74 SELECTOR_EXPORT TopoDS_Shape value();
76 /// Returns the naming name of the selection
77 SELECTOR_EXPORT std::string name(Selector_NameGenerator* theNameGenerator);
79 /// Makes the current local selection becomes all sub-shapes with same base geometry.
80 SELECTOR_EXPORT void combineGeometrical(const TopoDS_Shape theContext);
82 /// Stores the selected shape in he tree and returns true if shape found correctly
83 SELECTOR_EXPORT bool solve(const TopoDS_Shape theContext);