Salome HOME
Issue #2593: CEA 2018-2 Geometrical Naming
[modules/shaper.git] / src / Model / Model_AttributeSelection.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef Model_AttributeSelection_H_
22 #define Model_AttributeSelection_H_
23
24 #include "Model.h"
25 #include "Model_AttributeReference.h"
26 #include <ModelAPI_AttributeSelection.h>
27 #include <Selector_NameGenerator.h>
28 #include <TDF_LabelMap.hxx>
29 #include <TopoDS_Shape.hxx>
30 #include <TopTools_ListOfShape.hxx>
31
32 class Model_AttributeSelectionList;
33 class Model_Document;
34
35 /**\class Model_AttributeSelection
36  * \ingroup DataModel
37  * \brief Attribute that contains reference to the sub-shape of some result, the selected shape.
38  */
39 class Model_AttributeSelection : public ModelAPI_AttributeSelection,
40                                  public Selector_NameGenerator
41 {
42   Model_AttributeReference myRef;  ///< The reference functionality re-usage
43   /// temporarily storages to avoid keeping in the data structure if not needed
44   ResultPtr myTmpContext;
45   /// temporarily storages to avoid keeping in the data structure if not needed
46   std::shared_ptr<GeomAPI_Shape> myTmpSubShape;
47   /// temporarily storages to avoid keeping in the data structure if not needed
48   CenterType myTmpCenterType;
49   /// Reference to the parent attribute, if any (to split selection compounds in issue 1799)
50   Model_AttributeSelectionList* myParent;
51
52   std::shared_ptr<Model_Document> myRestoreDocument; // current document to restore by name
53   /// If true attribute selects geometry instead of shape.
54   bool myIsGeometricalSelection;
55
56 public:
57   /// Defines the result and its selected sub-shape
58   /// \param theContext object where the sub-shape was selected
59   /// \param theSubShape selected sub-shape (if null, the whole context is selected)
60   /// \param theTemporarily if it is true, do not store and name the added in the data framework
61   ///           (used to remove immediately, without the following updates)
62   /// \returns true if attribute was updated
63   MODEL_EXPORT virtual bool setValue(
64     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
65     const bool theTemporarily = false);
66
67   /// Same as SetValue, but it takes an edge (on circular or elliptical curve)
68   /// and stores the vertex of the central point (for ellipse the first or the second focus point)
69   MODEL_EXPORT virtual void setValueCenter(
70     const ObjectPtr& theContext, const std::shared_ptr<GeomAPI_Edge>& theEdge,
71     const CenterType theCenterType,
72     const bool theTemporarily = false);
73
74   /// Makes this selection attribute selects the same as in theSource selection
75   MODEL_EXPORT virtual void selectValue(
76     const std::shared_ptr<ModelAPI_AttributeSelection>& theSource);
77
78   /// Reset temporary stored values
79   virtual void removeTemporaryValues();
80
81   /// Returns the selected subshape
82   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> value();
83
84   /// Returns the context of the selection (the whole shape owner)
85   MODEL_EXPORT virtual ResultPtr context();
86
87   /// Returns the context of the selection if the whole feature was selected
88   MODEL_EXPORT virtual FeaturePtr contextFeature();
89   /// Returns the context of the selection : result or feature
90   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Object> contextObject();
91
92   /// Sets the feature object
93   MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
94
95   /// Updates the selection due to the changes in the referenced objects
96   /// \returns false if update is failed
97   MODEL_EXPORT virtual bool update();
98
99   /// Returns a textual string of the selection
100   /// \param theDefaultValue a name, which is returned if the naming name can not be obtained
101   MODEL_EXPORT virtual std::string namingName(const std::string& theDefaultValue = "");
102
103   /// Returns an Id of the selection
104   /// NOTE: This method has been added for temporary export of groups towards old GEOM
105   /// It should then be removed when a direct use of objects from SHAPER
106   /// will be possible from SMESH module of SALOME.
107   MODEL_EXPORT virtual int Id();
108
109   /// Defines the sub-shape by Id
110   /// NOTE: This method is opposite to Id() method.
111   MODEL_EXPORT virtual void setId(int theID);
112
113   /// Selects (i.e. creates Naming data structure) of sub-shape specified by textual name
114   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
115                                            const std::string& theSubShapeName);
116
117   /// Selects sub-shape by its inner point
118   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
119                                            const std::shared_ptr<GeomAPI_Pnt>& thePoint);
120   /// Selects sub-shape by weak naming index
121   MODEL_EXPORT virtual void selectSubShape(const std::string& theType,
122     const std::string& theContextName, const int theIndex);
123
124   /// Returns true if attribute was  initialized by some value
125   MODEL_EXPORT virtual bool isInitialized();
126
127   /// Returns true if recompute of selection become impossible
128   MODEL_EXPORT virtual bool isInvalid();
129
130   /// Updates the arguments of selection if something was affected by creation
131   /// or reorder of features upper in the history line (issue #1757)
132   MODEL_EXPORT virtual void updateInHistory();
133
134   // Implementation of the name generator method from the Selector package
135   // This method returns the context name by the label of the sub-selected shape
136   MODEL_EXPORT virtual std::string contextName(const TDF_Label theSelectionLab) override;
137
138   /// This method restores by the context and value name the context label and
139   /// sub-label where the value is. Returns true if it is valid.
140   MODEL_EXPORT virtual bool restoreContext(std::string theName,
141     TDF_Label& theContext, TDF_Label& theValue) override;
142
143   /// Returns the label of the newest context presented by the current one
144   MODEL_EXPORT virtual TDF_Label newestContext(const TDF_Label theCurrentContext) override;
145
146   /// Returns true if the first result is newer than the second one in the tree of features
147   MODEL_EXPORT virtual bool isLater(const TDF_Label theResult1, const TDF_Label theResult2)
148     const override;
149
150   /// Returns the name by context. Adds the part name if the context is located in other document
151   MODEL_EXPORT virtual std::string contextName(const ResultPtr& theContext) const;
152
153 protected:
154   /// Objects are created for features automatically
155   MODEL_EXPORT Model_AttributeSelection(TDF_Label& theLabel);
156
157   /// Returns the selected subshape, internal method that works without knowledge
158   /// about special selection of circle and ellipse focuses (for that the public value
159   /// method calls this and makes additional processing).
160   /// Returns theType type of the center, or NOT_CENTER if it is not.
161   std::shared_ptr<GeomAPI_Shape> internalValue(CenterType& theType);
162
163   /// Performs the selection for the body result (TNaming selection)
164   virtual void selectBody(
165     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape);
166
167   /// Performs the selection for the part result (selection by name of body result inside of part)
168   /// \param theContext the result - owner of the selection
169   /// \param theSubShape selected shape
170   /// \param theUpdate flag that shows that it must be just update, theShape is null
171   /// \returns true if everything is selected correctly
172   virtual bool selectPart(
173     const ResultPtr& theContext, const std::shared_ptr<GeomAPI_Shape>& theSubShape,
174     const bool theUpdate = false);
175
176   /// Returns the label where TNaming_Selection results are stored
177   /// Note: there must be no attributes stored at the same label because Selector clears this lab
178   TDF_Label selectionLabel();
179
180   /// Sets the ID of the attribute in Data (called from Data): here it is used for myRef ID setting
181   MODEL_EXPORT virtual void setID(const std::string theID);
182
183   /// Sets the parent attribute
184   void setParent(Model_AttributeSelectionList* theParent);
185
186   /// Splits theNewShape into sub-shapes of theType type (for the list parent of this attribute)
187   void split(ResultPtr theContext, TopoDS_Shape theNewShape, TopAbs_ShapeEnum theType);
188
189   /// When group position is updated, searches the new context and new values
190   bool searchNewContext(std::shared_ptr<Model_Document> theDoc, const TopoDS_Shape theContShape,
191                         ResultPtr theContext, TopoDS_Shape theValShape, TDF_Label theAccessLabel,
192                         std::list<ResultPtr>& theResults, TopTools_ListOfShape& theValShapes);
193
194   /// Searches for the newest context, modification of the current, that contains theValue
195   ResultPtr newestContext(const ResultPtr theCurrent,
196     const std::shared_ptr<GeomAPI_Shape> theValue, const bool theAnyValue = false);
197
198   /// computes theShapes list - shapes that were generated/modified/deleted the theValShape
199   /// during creation from new to old context
200   void computeValues(ResultPtr theOldContext, ResultPtr theNewContext, TopoDS_Shape theValShape,
201     TopTools_ListOfShape& theShapes);
202
203   /// Returns true if is geometrical selection.
204   virtual bool isGeometricalSelection() const {
205     return myIsGeometricalSelection;
206   };
207
208   friend class Model_Data;
209   friend class Model_AttributeSelectionList;
210 };
211
212 #endif