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 Model_AttributeSelection_H_
22 #define Model_AttributeSelection_H_
25 #include "Model_AttributeReference.h"
26 #include <ModelAPI_AttributeSelection.h>
27 #include <TDF_LabelMap.hxx>
28 #include <TopoDS_Shape.hxx>
30 class Model_AttributeSelectionList;
32 /**\class Model_AttributeSelection
34 * \brief Attribute that contains reference to the sub-shape of some result, the selected shape.
36 class Model_AttributeSelection : public ModelAPI_AttributeSelection
38 Model_AttributeReference myRef; ///< The reference functionality reusage
39 TDF_LabelMap myScope; ///< the map of valid labels for naming selection solving
40 /// temporarily storages to avoid keeping in the data structure if not needed
41 ResultPtr myTmpContext;
42 /// temporarily storages to avoid keeping in the data structure if not needed
43 std::shared_ptr<GeomAPI_Shape> myTmpSubShape;
44 /// Reference to the partent attribute, if any (to split selection compounds in issue 1799)
45 Model_AttributeSelectionList* myParent;
47 /// Defines the result and its selected sub-shape
48 /// \param theContext object where the sub-shape was selected
49 /// \param theSubShape selected sub-shape (if null, the whole context is selected)
50 /// \param theTemporarily if it is true, do not store and name the added in the data framework
51 /// (used to remove immideately, without the following updates)
52 MODEL_EXPORT virtual void setValue(
53 const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
54 const bool theTemporarily = false);
56 /// Reset temporary stored values
57 virtual void removeTemporaryValues();
59 /// Returns the selected subshape
60 MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
62 /// Returns the context of the selection (the whole shape owner)
63 MODEL_EXPORT virtual ResultPtr context();
65 /// Sets the feature object
66 MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
68 /// Updates the underlied selection due to the changes in the referenced objects
69 /// \returns false if update is failed
70 MODEL_EXPORT virtual bool update();
72 /// Returns a textual string of the selection
73 /// \param theDefaultValue a name, which is returned if the naming name can not be obtained
74 MODEL_EXPORT virtual std::string namingName(const std::string& theDefaultValue = "");
76 /// Returns an Id of the selection
77 /// NOTE: This method has been added for temporary export of groups towards old GEOM
78 /// It should then be removed when a direct use of objects from SHAPER
79 /// will be possible from SMESH module of SALOME.
80 MODEL_EXPORT virtual int Id();
82 /// Defines the sub-shape by Id
83 /// NOTE: This method is opposite to Id() method.
84 MODEL_EXPORT virtual void setId(int theID);
86 /// Selects (i.e. creates Naming data structure) of sub-shape specifed by textual name
87 MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
88 const std::string& theSubShapeName);
90 /// Returns true if attribute was initialized by some value
91 MODEL_EXPORT virtual bool isInitialized();
93 /// Returns true if recomute of selection become impossible
94 MODEL_EXPORT virtual bool isInvalid();
96 /// Updates the arguments of selection if something was affected by creation
97 /// or reorder of features upper in the history line (issue #1757)
98 MODEL_EXPORT virtual void updateInHistory();
101 /// Objects are created for features automatically
102 MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
104 /// Performs the selection for the body result (TNaming Selection)
106 /// Performs the selection for the body result (TNaming selection)
107 virtual void selectBody(
108 const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
110 /// Performs the selection for the part result (selection by name of body result inside of part)
111 /// \param theContext the result - owner of the selection
112 /// \param theSubShape selected shape
113 /// \param theUpdate flag that shows that it must be just update, theShape is null
114 /// \returns true if eveything is selected correctly
115 virtual bool selectPart(
116 const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
117 const bool theUpdate = false);
119 /// Returns the label where TNaming_Selection results are stored
120 /// Note: there must be no attributes stored at the same label because Selector clears this lab
121 TDF_Label selectionLabel();
123 /// Returns the prepared map of valid labels for naming selection solving (creates if not exists)
124 TDF_LabelMap& scope();
126 /// Sets the ID of the attribute in Data (called from Data): here it is used for myRef ID setting
127 MODEL_EXPORT virtual void setID(const std::string theID);
129 /// Returns the name by context. Adds the part name if the context is located in other document
130 std::string contextName(const ResultPtr& theContext) const;
132 /// Sets the parent attribute
133 void setParent(Model_AttributeSelectionList* theParent);
135 /// Splits theNewShape into sub-shapes of theType type (for the list parent of this attribute)
136 void split(ResultPtr theContext, TopoDS_Shape theNewShape, TopAbs_ShapeEnum theType);
138 friend class Model_Data;
139 friend class Model_AttributeSelectionList;