1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
4 * ModuleBase_OperationFeature.cpp
6 * Created on: Apr 2, 2014
10 #include "ModuleBase_OperationFeature.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_OperationFeature::ModuleBase_OperationFeature(const QString& theId, QObject* theParent)
41 : ModuleBase_Operation(theId, theParent),
46 ModuleBase_OperationFeature::~ModuleBase_OperationFeature()
51 FeaturePtr ModuleBase_OperationFeature::feature() const
56 bool ModuleBase_OperationFeature::isValid() const
58 if (!myFeature || !myFeature->data()->isValid())
59 return true; // rename operation
60 if (myFeature->isAction())
62 //Get validators for the Id
63 SessionPtr aMgr = ModelAPI_Session::get();
64 ModelAPI_ValidatorsFactory* aFactory = aMgr->validators();
65 bool aValid = aFactory->validate(myFeature);
67 // the feature exec state should be checked in order to do not apply features, which result can not
68 // be built. E.g. extrusion on sketch, where the "to" is a perpendicular plane to the sketch
69 bool isDone = ( myFeature->data()->execState() == ModelAPI_StateDone
70 || myFeature->data()->execState() == ModelAPI_StateMustBeUpdated );
72 return aValid && isDone;
75 FeaturePtr ModuleBase_OperationFeature::createFeature(const bool theFlushMessage)
77 if (myParentFeature.get()) {
78 myFeature = myParentFeature->addFeature(getDescription()->operationId().toStdString());
80 std::shared_ptr<ModelAPI_Document> aDoc = ModelAPI_Session::get()->activeDocument();
81 myFeature = aDoc->addFeature(getDescription()->operationId().toStdString());
83 if (myFeature) { // TODO: generate an error if feature was not created
85 // Model update should call "execute" of a feature.
86 //myFeature->execute();
87 // Init default values
88 /*QList<ModuleBase_ModelWidget*> aWidgets = getDescription()->modelWidgets();
89 QList<ModuleBase_ModelWidget*>::const_iterator anIt = aWidgets.begin(), aLast = aWidgets.end();
90 for (; anIt != aLast; anIt++) {
91 (*anIt)->storeValue(aFeature);
96 Events_Loop::loop()->flush(Events_Loop::eventByName(EVENT_OBJECT_CREATED));
100 void ModuleBase_OperationFeature::setFeature(FeaturePtr theFeature)
102 myFeature = theFeature;
106 bool ModuleBase_OperationFeature::hasObject(ObjectPtr theObj) const
108 FeaturePtr aFeature = feature();
110 if (aFeature == theObj)
112 std::list<ResultPtr> aResults = aFeature->results();
113 std::list<ResultPtr>::const_iterator aIt;
114 for (aIt = aResults.cbegin(); aIt != aResults.cend(); ++aIt) {
115 if (theObj == (*aIt))
122 void ModuleBase_OperationFeature::start()
124 setIsModified(false);
125 QString anId = getDescription()->operationId();
127 anId = anId.append(EditSuffix());
129 ModelAPI_Session::get()->startOperation(anId.toStdString());
134 FeaturePtr aFeature = createFeature();
135 // if the feature is not created, there is no sense to start the operation
136 if (aFeature.get() == NULL) {
137 // it is necessary to abor the operation in the session and emit the aborted signal
138 // in order to update commands status in the workshop, to be exact the feature action
144 /// Set current feature and remeber old current feature
146 SessionPtr aMgr = ModelAPI_Session::get();
147 DocumentPtr aDoc = aMgr->activeDocument();
148 myCurrentFeature = aDoc->currentFeature(true);
149 aDoc->setCurrentFeature(feature(), false);
157 void ModuleBase_OperationFeature::abort()
159 // the viewer update should be blocked in order to avoid the features blinking before they are
161 std::shared_ptr<Events_Message> aMsg = std::shared_ptr<Events_Message>(
162 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_BLOCKED)));
163 Events_Loop::loop()->send(aMsg);
165 // the widgets of property panel should not process any events come from data mode
166 // after abort clicked. Some signal such as redisplay/create influence on content
167 // of the object browser and viewer context. Therefore it influence to the current
168 // selection and if the active widget listens it, the attribute value is errnoneous
170 ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
172 aPropertyPanel->cleanContent();
174 SessionPtr aMgr = ModelAPI_Session::get();
176 DocumentPtr aDoc = aMgr->activeDocument();
177 bool aIsOp = aMgr->isOperation();
179 aMgr->startOperation();
180 aDoc->setCurrentFeature(myCurrentFeature, true);
182 aMgr->finishOperation();
183 myCurrentFeature = FeaturePtr();
188 // is is necessary to deactivate current widgets before the model operation is aborted
189 // because abort removes the feature and activated filters should not check it
190 propertyPanel()->cleanContent();
192 aMgr->abortOperation();
194 // the viewer update should be unblocked in order to avoid the features blinking before they are
196 aMsg = std::shared_ptr<Events_Message>(
197 new Events_Message(Events_Loop::eventByName(EVENT_UPDATE_VIEWER_UNBLOCKED)));
199 Events_Loop::loop()->send(aMsg);
204 bool ModuleBase_OperationFeature::commit()
206 if (canBeCommitted()) {
207 // the widgets of property panel should not process any events come from data mode
208 // after commit clicked. Some signal such as redisplay/create influence on content
209 // of the object browser and viewer context. Therefore it influence to the current
210 // selection and if the active widget listens it, the attribute value is errnoneous
212 ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
214 aPropertyPanel->cleanContent();
216 SessionPtr aMgr = ModelAPI_Session::get();
217 /// Set current feature and remeber old current feature
219 DocumentPtr aDoc = aMgr->activeDocument();
220 bool aIsOp = aMgr->isOperation();
222 aMgr->startOperation();
223 aDoc->setCurrentFeature(myCurrentFeature, true);
225 aMgr->finishOperation();
226 myCurrentFeature = FeaturePtr();
229 aMgr->finishOperation();
235 afterCommitOperation();
241 void ModuleBase_OperationFeature::activateByPreselection()
243 if (myPreSelection.empty())
246 ModuleBase_ModelWidget* aFilledWgt = 0;
247 ModuleBase_IPropertyPanel* aPropertyPanel = propertyPanel();
248 if (aPropertyPanel) {
249 const QList<ModuleBase_ModelWidget*>& aWidgets = aPropertyPanel->modelWidgets();
250 if (!aWidgets.empty()) {
251 ModuleBase_ModelWidget* aWgt = 0;
252 QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
254 // 1. apply the selection to controls
255 for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
257 if (!aWgt->canSetValue())
259 aPropertyPanel->setPreselectionWidget(aWgt);
260 if (!aWgt->setSelection(myPreSelection, true)) {
268 aPropertyPanel->setPreselectionWidget(NULL);
269 // in order to redisplay object in the viewer, the update/redisplay signals should be flushed
270 // it is better to perform it not in setSelection of each widget, but do it here,
271 // after the preselection is processed
272 ModuleBase_ModelWidget::updateObject(myFeature);
274 // 3. a signal should be emitted before the next widget activation
275 // because, the activation of the next widget will give a focus to the widget. As a result
276 // the value of the widget is initialized. And commit may happens until the value is entered.
278 emit activatedByPreselection();
280 // 4. activate the next obligatory widget
281 aPropertyPanel->activateNextWidget(aFilledWgt);
287 void ModuleBase_OperationFeature::setParentFeature(CompositeFeaturePtr theParent)
289 myParentFeature = theParent;
292 CompositeFeaturePtr ModuleBase_OperationFeature::parentFeature() const
294 return myParentFeature;
297 void ModuleBase_OperationFeature::initSelection(ModuleBase_ISelection* theSelection,
298 ModuleBase_IViewer* theViewer)
302 QList<ModuleBase_ViewerPrs> aPreSelected;
303 // Check that the selected result are not results of operation feature
304 FeaturePtr aFeature = feature();
306 QList<ModuleBase_ViewerPrs> aSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
308 std::list<ResultPtr> aResults = aFeature->results();
309 QObjectPtrList aResList;
310 std::list<ResultPtr>::const_iterator aIt;
311 for (aIt = aResults.begin(); aIt != aResults.end(); ++aIt)
312 aResList.append(*aIt);
314 foreach (ModuleBase_ViewerPrs aPrs, aSelected) {
315 if ((!aResList.contains(aPrs.object())) && (aPrs.object() != aFeature))
316 aPreSelected.append(aPrs);
319 aPreSelected = theSelection->getSelected(ModuleBase_ISelection::AllControls);
321 myPreSelection = aPreSelected;
324 void ModuleBase_OperationFeature::clearPreselection()
326 myPreSelection.clear();
329 void ModuleBase_OperationFeature::setPropertyPanel(ModuleBase_IPropertyPanel* theProp)
331 ModuleBase_Operation::setPropertyPanel(theProp);
333 theProp->setEditingMode(isEditOperation());
336 const QList<ModuleBase_ModelWidget*>& aWidgets = theProp->modelWidgets();
337 QList<ModuleBase_ModelWidget*>::const_iterator aWIt;
338 for (aWIt = aWidgets.constBegin(); aWIt != aWidgets.constEnd(); ++aWIt) {
339 ModuleBase_ModelWidget* aWgt = (*aWIt);
340 connect(aWgt, SIGNAL(valuesChanged()), this, SLOT(onValuesChanged()));
344 // Do not activate widgets by default if the current operation is editing operation
345 // Because we don't know which widget is going to be edited.
346 if (!isEditOperation()) {
347 // 4. activate the first obligatory widget
348 theProp->activateNextWidget(NULL);
352 bool ModuleBase_OperationFeature::isGranted(QString theId) const
354 return myNestedFeatures.contains(theId);