SHAPER  9.12.0
Selector_Selector.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_Selector_H_
21 #define Selector_Selector_H_
22 
23 #include "Selector.h"
24 
25 #include <TDF_Label.hxx>
26 #include <TopoDS_Shape.hxx>
27 
29 class Selector_Algo;
30 
37 {
38  TDF_Label myLab;
39  TDF_Label myBaseDocumentLab;
40  Selector_Algo* myAlgo;
41 
42 public:
44  SELECTOR_EXPORT Selector_Selector(TDF_Label theLab, TDF_Label theBaseDocLab = TDF_Label());
45 
47  SELECTOR_EXPORT ~Selector_Selector();
48 
56  SELECTOR_EXPORT bool select(const TopoDS_Shape theContext, const TopoDS_Shape theValue,
57  const bool theGeometricalNaming = false);
58 
60  SELECTOR_EXPORT bool store(const TopoDS_Shape theContext);
61 
64  SELECTOR_EXPORT bool restore(const TopoDS_Shape theContext);
65 
68  SELECTOR_EXPORT TDF_Label restoreByName(
69  std::wstring theName, const TopAbs_ShapeEnum theShapeType,
70  Selector_NameGenerator* theNameGenerator, const bool theGeometricalNaming = false);
71 
73  SELECTOR_EXPORT TopoDS_Shape value();
74 
76  SELECTOR_EXPORT std::wstring name(Selector_NameGenerator* theNameGenerator);
77 
79  SELECTOR_EXPORT void combineGeometrical(const TopoDS_Shape theContext);
80 
82  SELECTOR_EXPORT bool solve(const TopoDS_Shape theContext);
83 };
84 
85 #endif
Definition: Selector_Algo.h:37
An interface for generation of the naming name basing on the current selection and document informati...
Definition: Selector_NameGenerator.h:34
Base class for all kinds of selection algorithms.
Definition: Selector_Selector.h:37
Selector_Selector(TDF_Label theLab, TDF_Label theBaseDocLab=TDF_Label())
Initializes selector on the label.
Definition: Selector_Selector.cpp:31
bool solve(const TopoDS_Shape theContext)
Stores the selected shape in he tree and returns true if shape found correctly.
Definition: Selector_Selector.cpp:108
bool restore(const TopoDS_Shape theContext)
Restores the selected shape by the topological naming kept in the data structure Returns true if it c...
Definition: Selector_Selector.cpp:59
std::wstring name(Selector_NameGenerator *theNameGenerator)
Returns the naming name of the selection.
Definition: Selector_Selector.cpp:76
bool select(const TopoDS_Shape theContext, const TopoDS_Shape theValue, const bool theGeometricalNaming=false)
Initializes the selector structure on the label.
Definition: Selector_Selector.cpp:41
~Selector_Selector()
Destructor.
Definition: Selector_Selector.cpp:35
TDF_Label restoreByName(std::wstring theName, const TopAbs_ShapeEnum theShapeType, Selector_NameGenerator *theNameGenerator, const bool theGeometricalNaming=false)
Restores the selected shape by the topological name string.
Definition: Selector_Selector.cpp:80
TopoDS_Shape value()
Returns the current sub-shape value (null if can not resolve)
Definition: Selector_Selector.cpp:68
bool store(const TopoDS_Shape theContext)
Stores the name to the label and sub-labels tree.
Definition: Selector_Selector.cpp:53
void combineGeometrical(const TopoDS_Shape theContext)
Makes the current local selection becomes all sub-shapes with same base geometry.
Definition: Selector_Selector.cpp:93