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_Update_H_
22 #define Model_Update_H_
25 #include <ModelAPI_Data.h>
26 #include "Events_Listener.h"
31 class ModelAPI_Object;
32 class ModelAPI_Feature;
33 class ModelAPI_CompositeFeature;
36 /**\class Model_Update
38 * \brief Updates the results of features when it is needed.
40 class Model_Update : public Events_Listener
42 /// Features and results that were modified and not yet processed.
43 /// The second set is the objects that causes this object is modified
44 std::map<std::shared_ptr<ModelAPI_Feature>, std::set<std::shared_ptr<ModelAPI_Feature> > >
46 /// Features which arguments were modified by not-persistent changes.
47 /// So, these referencing arguments must be updated
48 /// due to these features info also before execution).
49 std::map<std::shared_ptr<ModelAPI_Feature>, std::set<std::shared_ptr<ModelAPI_Feature> > >
51 /// features that must be additionally processed after execution of finish operation
52 std::set<std::shared_ptr<ModelAPI_Feature> > myWaitForFinish;
53 /// to know that some parameter was changed during this operation (to enable update expressions)
54 bool myIsParamUpdated;
55 /// to execute features on finish if preview is needed only on finish operation
57 /// try if processing is currently performed
59 /// map that contains features that must be executed only on finish of the operation
60 /// the value in map is the set of reasons
61 std::map<std::shared_ptr<ModelAPI_Feature>, std::set<std::shared_ptr<ModelAPI_Feature> > >
63 /// to avoid infinitive cycling: feature -> count of the processing periods during this update
64 std::map<std::shared_ptr<ModelAPI_Feature>, int > myProcessed;
65 /// if preview in the property panel is blocked any update is postponed until end of operation
66 bool myIsPreviewBlocked;
67 /// disables any update if it is true, even on start/finish operation, undo, etc.
71 /// Is called only once, on startup of the application
74 /// Processes the feature argument update: executes the results
75 MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
78 /// Appends the new modified feature to the myModified, clears myProcessed if needed
79 /// Returns true if some feature really was marked as modified
80 /// theReason is the object that causes modification of this feature
81 /// returns true if something reallsy was added to the modified and must be processed
83 std::shared_ptr<ModelAPI_Feature> theFeature, std::shared_ptr<ModelAPI_Feature> theReason);
85 /// Recoursively checks and updates features if needed (calls the execute method)
86 /// Returns true if feature was updated.
87 bool processFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
89 /// Updates the selection and parametrical arguments before the later feature analysis
90 /// Returns true if something really was updated
91 void updateArguments(std::shared_ptr<ModelAPI_Feature> theFeature);
93 /// Sends the redisplay events for feature and results, updates the updated status
94 void redisplayWithResults(std::shared_ptr<ModelAPI_Feature> theFeature,
95 const ModelAPI_ExecState theState, bool theUpdateState = true);
97 /// On operation start/end/abort the "Just" fileds must be cleared and processed in the right way
98 //! \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
99 void processFeatures(const bool theFlushRedisplay = true);
101 /// Performs the feature execution
102 /// \returns the status of execution
103 void executeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
105 /// Updates the properties of object because of stability state changes
106 void updateStability(void* theSender);
108 /// Returns true if theFeature modification was caused by theReason
109 /// (may be feature of result of this feature)
111 std::shared_ptr<ModelAPI_Feature>& theFeature, std::shared_ptr<ModelAPI_Object> theReason);
113 /// Updates a selection attributes for the features that possible were affected by creation
114 /// or reorder of features upper in the history line (issue #1757)
115 void updateSelection(const std::set<std::shared_ptr<ModelAPI_Object> >& theObjects);