2 * ModuleBase_Operation.h
4 * Created on: Apr 2, 2014
8 #ifndef ModuleBase_Operation_H
9 #define ModuleBase_Operation_H
11 #include <ModuleBase.h>
12 #include <ModuleBase_ViewerPrs.h>
14 #include <ModelAPI_CompositeFeature.h>
15 #include <ModelAPI_Document.h>
19 #include <QStringList>
21 class ModuleBase_ModelWidget;
22 class ModuleBase_OperationDescription;
23 class ModuleBase_IPropertyPanel;
24 class ModuleBase_ISelection;
25 class ModuleBase_IViewer;
26 class ModuleBase_WidgetValueFeature;
31 \class ModuleBase_Operation
32 * \brief Base class for all operations
34 * Base class for all operations. If you perform an action it is reasonable to create
35 * operation intended for this. This is a base class for all operations which provides
36 * mechanism for correct starting operations, starting operations above already started
37 * ones, committing operations and so on. To create own operation it is reasonable to
38 * inherit it from this class and redefines virtual methods to provide own behavior
39 * Main virtual methods are
40 * - virtual bool isReadyToStart();
41 * - virtual void startOperation();
42 * - virtual void abortOperation();
43 * - virtual void commitOperation();
46 class MODULEBASE_EXPORT ModuleBase_Operation : public QObject
52 /// \param theId the operation identifier
53 /// \param theParent the QObject parent
54 ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
56 virtual ~ModuleBase_Operation();
58 /// Returns the operation description
59 /// /returns the instance of the description class
60 ModuleBase_OperationDescription* getDescription() const { return myDescription; }
63 * Must return true if this operation can be launched as nested for any current operation
64 * and it is not necessary to check this operation on validity. By default
65 * the operation is not granted.
66 * The method has to be redefined for granted operations.
68 virtual bool isGranted(QString theId) const;
70 /// Sets a list of model widgets, according to the operation feature xml definition
71 /// \param theXmlRepresentation an xml feature definition
72 /// \param theWidgets a list of widgets
73 //void setModelWidgets(const std::string& theXmlRepresentation,
74 // QList<ModuleBase_ModelWidget*> theWidgets);
76 /// Returns True if data of its feature was modified during operation
77 virtual bool isModified() const { return myIsModified; }
79 /// Returns True id the current operation is launched in editing mode
80 bool isEditOperation() const { return myIsEditing; }
82 /// Returns list of nested features
83 QStringList nestedFeatures() const { return myNestedFeatures; }
85 /// Sets list of nested features
86 void setNestedFeatures(const QStringList& theList) { myNestedFeatures = theList; }
89 // Returns operations Id from it's description
92 /// Returns the operation feature
93 /// \return the feature
94 FeaturePtr feature() const;
97 * Must return True if the operation's feature is valid.
98 * Since IOperation does not have any feature returns false.
100 virtual bool isValid() const;
102 /// Returns whether the nested operations are enabled.
103 /// The state can depend on the operation current state.
104 /// \return enabled state
105 virtual bool isNestedOperationsEnabled() const;
107 /// Sets the operation feature
108 void setFeature(FeaturePtr theFeature);
110 /// Returns True if the current operation works with the given object (feature or result)
111 virtual bool hasObject(ObjectPtr theObj) const;
113 //virtual void keyReleased(const int theKey) {};
115 /// If operation needs to redisplay its result during operation
116 /// then this method has to return True
117 //virtual bool hasPreview() const { return false; }
119 /// Initialisation of operation with preliminary selection
120 /// \param theSelected the list of selected presentations
121 /// \param theHighlighted the list of highlighted presentations
122 /// \param theViewer a viewer to have the viewer the eye position
123 virtual void initSelection(ModuleBase_ISelection* theSelection,
124 ModuleBase_IViewer* /* theViewer*/);
126 virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
128 ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
130 /// Activates widgets by preselection if it is accepted
131 virtual bool activateByPreselection();
133 /// If the operation works with feature which is sub-feature of another one
134 /// then this variable has to be initialised by parent feature
135 /// before operation feature creating
136 void setParentFeature(CompositeFeaturePtr theParent) { myParentFeature = theParent; }
137 CompositeFeaturePtr parentFeature() const { return myParentFeature; }
140 void started(); /// the operation is started
141 void aborted(); /// the operation is aborted
142 void committed(); /// the operation is committed
143 void stopped(); /// the operation is aborted or committed
144 void resumed(); /// the operation is resumed
145 void postponed(); /// the operation is postponed
149 /// Public slot. Verifies whether operation can be started and starts operation.
150 /// This slot is not virtual and cannot be redefined. Redefine startOperation method
151 /// to change behavior of operation. There is no point in using this method. It would
152 /// be better to inherit own operator from base one and redefine startOperation method
156 /// Deactivates current operation which can be resumed later.
159 /// Resumes operation
160 /// Public slot. Verifies whether operation can be started and starts operation.
161 /// This slot is not virtual and cannot be redefined. Redefine startOperation method
162 /// to change behavior of operation. There is no point in using this method. It would
163 /// be better to inherit own operator from base one and redefine startOperation method
168 /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined.
169 /// Redefine abortOperation method to change behavior of operation instead
172 /// Commits operation
173 /// Public slot. Commits operation. This slot is not virtual and cannot be redefined.
174 /// Redefine commitOperation method to change behavior of operation instead
177 /// Alias for start/abort slots
178 /// Public slot. Aborts operation if false, else does nothing.
179 /// Provided for S/S compatibility with QAction's toggle(bool)
180 /// \param theState th flag to abort, if it is true, do nothing, overwise abort
181 void setRunning(bool theState);
183 // Data model methods.
184 /// Stores a custom value in model.
185 //virtual void storeCustomValue();
187 /// Slots which listen the mode widget activation
188 /// \param theWidget the model widget
189 //virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
192 /// Virtual method called when operation started (see start() method for more description)
193 /// Default impl calls corresponding slot and commits immediately.
194 virtual void startOperation() {}
196 /// Implementation of specific steps on postpone operation
197 virtual void postponeOperation() {}
199 /// Virtual method called when operation stopped - committed or aborted.
200 virtual void stopOperation() {}
202 /// Virtual method called when operation aborted (see abort() method for more description)
203 virtual void abortOperation() {}
205 /// Virtual method called when operation committed (see commit() method for more description)
206 virtual void commitOperation() {}
208 /// Virtual method called after operation committed (see commit() method for more description)
209 virtual void afterCommitOperation() {}
211 /// Send update message by loop
212 //void flushUpdated();
214 /// Send created message by loop
217 /// Creates an operation new feature
218 /// \param theFlushMessage the flag whether the create message should be flushed
219 /// \param theCompositeFeature the feature that must be used for adding the created object or null
220 /// \returns the created
221 virtual FeaturePtr createFeature(const bool theFlushMessage = true);
223 /// Verifies whether this operator can be commited.
224 /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled
225 virtual bool canBeCommitted() const;
227 /// Returns pointer to the root document.
228 std::shared_ptr<ModelAPI_Document> document() const;
230 /// Set value to the active widget
231 /// \param theFeature the feature
232 /// \param theX the horizontal coordinate
233 /// \param theY the vertical coordinate
234 /// \return true if the point is set
235 //virtual bool setWidgetValue(ObjectPtr theFeature, double theX, double theY);
237 /// Return a widget value point by the selection and the viewer position
238 /// The default realization returns false
239 /// \param thePrs the presentation
240 /// \param theViewer a viewer to have the viewer the eye position
241 /// \param theX the horizontal coordinate
242 /// \param theY the vertical coordinate
243 /// \return true if the point exits in the selection
244 virtual bool getViewerPoint(ModuleBase_ViewerPrs thePrs,
245 ModuleBase_IViewer* theViewer,
246 double& theX, double& theY);
248 // Removes the preselection information and clears the map of preselection
249 void clearPreselection();
252 FeaturePtr myFeature; /// the operation feature to be handled
254 /// the container to have the operation description
255 ModuleBase_OperationDescription* myDescription;
257 /// Editing feature flag
260 /// Modified feature flag
263 /// List of nested operations IDs
264 QStringList myNestedFeatures;
266 /// List of pre-selected object
267 QList<ModuleBase_WidgetValueFeature*> myPreSelection;
269 /// Access to property panel
270 ModuleBase_IPropertyPanel* myPropertyPanel;
272 /// If the operation works with feature which is sub-feature of another one
273 /// then this variable has to be initialised by parent feature
274 /// before operation feature creating
275 CompositeFeaturePtr myParentFeature;