1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_Operation.cpp
6 * Created on: Apr 2, 2014
10 #include "ModuleBase_Operation.h"
12 #include "ModuleBase_OperationDescription.h"
13 #include "ModuleBase_ModelWidget.h"
14 #include "ModuleBase_ViewerPrs.h"
15 #include "ModuleBase_IPropertyPanel.h"
16 #include "ModuleBase_ISelection.h"
17 #include "ModuleBase_IViewer.h"
19 #include <ModelAPI_AttributeDouble.h>
20 #include <ModelAPI_Document.h>
21 #include <ModelAPI_Feature.h>
22 #include <ModelAPI_Data.h>
23 #include <ModelAPI_Document.h>
24 #include <ModelAPI_Events.h>
25 #include <ModelAPI_Result.h>
26 #include <ModelAPI_Object.h>
27 #include <ModelAPI_Validator.h>
28 #include <ModelAPI_Session.h>
30 #include <GeomAPI_Pnt2d.h>
32 #include <Events_Loop.h>
40 ModuleBase_Operation::ModuleBase_Operation(const QString& theId, QObject* theParent)
46 myDescription = new ModuleBase_OperationDescription(theId);
49 ModuleBase_Operation::~ModuleBase_Operation()
55 QString ModuleBase_Operation::id() const
57 return getDescription()->operationId();
60 FeaturePtr ModuleBase_Operation::feature() const
65 bool ModuleBase_Operation::isValid() const
67 if (!myFeature || !myFeature->data()->isValid())
68 return true; // rename operation
69 if (myFeature->isAction())
71 //Get validators for the Id
72 SessionPtr aMgr = ModelAPI_Session::get();
73 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
74 bool aValid = aFactory->validate(myFeature);
76 // the feature exec state should be checked in order to do not apply features, which result can not
77 // be built. E.g. extrusion on sketch, where the "to" is a perpendicular plane to the sketch
78 bool isDone = ( myFeature->data()->execState() == ModelAPI_StateDone
79 || myFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
81 return aValid && isDone;
85 bool ModuleBase_Operation::canBeCommitted() const
90 FeaturePtr ModuleBase_Operation::createFeature(const bool theFlushMessage)
92 if (myParentFeature.get()) {
93 myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
95 std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
96 myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
98 if (myFeature) { // TODO: generate an error if feature was not created
100 // Model update should call "execute" of a feature.
101 //myFeature->execute();
102 // Init default values
103 /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
104 QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
105 for (; anIt != aLast; anIt++) {
106 (*anIt)->storeValue(aFeature);
111 Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
115 void ModuleBase_Operation::setFeature(FeaturePtr theFeature)
117 myFeature = theFeature;
121 bool ModuleBase_Operation::hasObject(ObjectPtr theObj) const
123 FeaturePtr aFeature = feature();
125 if (aFeature == theObj)
127 std::list<ResultPtr> aResults = aFeature->results();
128 std::list<ResultPtr>::const_iterator aIt;
129 for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
130 if (theObj == (*aIt))
137 void ModuleBase_Operation::start()
139 QString anId = getDescription()->operationId();
141 anId = anId.append(EditSuffix());
143 ModelAPI_Session::get()->startOperation(anId.toStdString());
146 FeaturePtr aFeature = createFeature();
147 // if the feature is not created, there is no sense to start the operation
148 if (aFeature.get() == NULL) {
149 // it is necessary to abor the operation in the session and emit the aborted signal
150 // in order to update commands status in the workshop, to be exact the feature action
156 /// Set current feature and remeber old current feature
158 SessionPtr aMgr = ModelAPI_Session::get();
159 DocumentPtr aDoc = aMgr->activeDocument();
160 myCurrentFeature = aDoc->currentFeature(true);
161 aDoc->setCurrentFeature(feature(), false);
169 void ModuleBase_Operation::postpone()
175 void ModuleBase_Operation::resume()
181 void ModuleBase_Operation::abort()
183 // the viewer update should be blocked in order to avoid the features blinking before they are
185 std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
186 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
187 Events_Loop::loop()->send(aMsg);
189 SessionPtr aMgr = ModelAPI_Session::get();
191 DocumentPtr aDoc = aMgr->activeDocument();
192 bool aIsOp = aMgr->isOperation();
194 aMgr->startOperation();
195 aDoc->setCurrentFeature(myCurrentFeature, true);
197 aMgr->finishOperation();
198 myCurrentFeature = FeaturePtr();
203 // is is necessary to deactivate current widgets before the model operation is aborted
204 // because abort removes the feature and activated filters should not check it
205 propertyPanel()->cleanContent();
207 aMgr->abortOperation();
209 // the viewer update should be unblocked in order to avoid the features blinking before they are
211 aMsg = std::shared_ptr<Events_Message>(
212 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
214 Events_Loop::loop()->send(aMsg);
219 bool ModuleBase_Operation::commit()
221 if (canBeCommitted()) {
222 SessionPtr aMgr = ModelAPI_Session::get();
223 /// Set current feature and remeber old current feature
225 DocumentPtr aDoc = aMgr->activeDocument();
226 bool aIsOp = aMgr->isOperation();
228 aMgr->startOperation();
229 aDoc->setCurrentFeature(myCurrentFeature, true);
231 aMgr->finishOperation();
232 myCurrentFeature = FeaturePtr();
235 // check whether there are modifications performed during the current operation
237 // in case if there are no modifications, do not increase the undo/redo stack
238 if (aMgr->isModified())
239 aMgr->finishOperation();
241 aMgr->abortOperation();
247 afterCommitOperation();
253 void ModuleBase_Operation::setRunning(bool theState)
255 emit triggered(theState);
258 //TODO: nds stabilization hotfix
259 void ModuleBase_Operation::commitOperation()
261 if(!myPropertyPanel) {
264 ModuleBase_ModelWidget* aWidget = myPropertyPanel->activeWidget();
266 aWidget->disconnectSignals();
269 void ModuleBase_Operation::activateByPreselection()
271 if (!myPropertyPanel || myPreSelection.empty()) {
272 myPropertyPanel->activateNextWidget(NULL);
275 const QList<ModuleBase_ModelWidget*>& aWidgets = myPropertyPanel->modelWidgets();
276 if (aWidgets.empty()) {
277 myPropertyPanel->activateNextWidget(NULL);
281 ModuleBase_ModelWidget* aWgt, *aFilledWgt = 0;
282 QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
284 // 1. apply the selection to controls
285 for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
287 if (!aWgt->canSetValue())
290 if (!aWgt->setSelection(myPreSelection)) {
298 // in order to redisplay object in the viewer, the update/redisplay signals should be flushed
299 // it is better to perform it not in setSelection of each widget, but do it here,
300 // after the preselection is processed
301 ModuleBase_ModelWidget::updateObject(myFeature);
303 // 2. ignore not obligatory widgets
304 /*for (; aWIt != aWidgets.constEnd(); ++aWIt) {
306 if (aWgt && aWgt->isObligatory())
311 // 3. a signal should be emitted before the next widget activation
312 // because, the activation of the next widget will give a focus to the widget. As a result
313 // the value of the widget is initialized. And commit may happens until the value is entered.
315 emit activatedByPreselection();
317 // 4. activate the next obligatory widget
318 myPropertyPanel->activateNextWidget(aFilledWgt);
321 void ModuleBase_Operation::setParentFeature(CompositeFeaturePtr theParent)
323 myParentFeature = theParent;
326 CompositeFeaturePtr ModuleBase_Operation::parentFeature() const
328 return myParentFeature;
331 void ModuleBase_Operation::initSelection(ModuleBase_ISelection* theSelection,
332 ModuleBase_IViewer* theViewer)
336 QList<ModuleBase_ViewerPrs> aPreSelected;
337 // Check that the selected result are not results of operation feature
338 FeaturePtr aFeature = feature();
340 QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
342 std::list<ResultPtr> aResults = aFeature->results();
343 QObjectPtrList aResList;
344 std::list<ResultPtr>::const_iterator aIt;
345 for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
346 aResList.append(*aIt);
348 foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
349 if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
350 aPreSelected.append(aPrs);
353 aPreSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
355 // convert the selection values to the values, which are set to the operation widgets
357 //Handle(V3d_View) aView = theViewer->activeView();
358 //foreach (ModuleBase_ViewerPrs aPrs, aPreSelected) {
359 // ModuleBase_WidgetValueFeature* aValue = new ModuleBase_WidgetValueFeature();
360 // aValue->setObject(aPrs.object());
363 // if (getViewerPoint(aPrs, theViewer, aX, anY))
364 // aValue->setPoint(std::shared_ptr<GeomAPI_Pnt2d>(new GeomAPI_Pnt2d(aX, anY)));
365 // myPreSelection.append(aValue);
367 myPreSelection = aPreSelected;
371 bool ModuleBase_Operation::getViewerPoint(ModuleBase_ViewerPrs thePrs,
372 ModuleBase_IViewer* theViewer,
373 double& theX, double& theY)
378 void ModuleBase_Operation::clearPreselection()
380 myPreSelection.clear();
383 void ModuleBase_Operation::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
385 myPropertyPanel = theProp;
386 myPropertyPanel->setEditingMode(isEditOperation());
388 // Do not activate widgets by default if the current operation is editing operation
389 // Because we don't know which widget is going to be edited.
390 if (!isEditOperation())
391 activateByPreselection();
394 bool ModuleBase_Operation::isGranted(QString theId) const
396 return myNestedFeatures.contains(theId);